Overview  Package   Class  Tree  Deprecated  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

org.apache.cocoon.xml.xlink
Class XLinkPipe

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.xml.AbstractXMLProducer
              |
              +--org.apache.cocoon.xml.AbstractXMLPipe
                    |
                    +--org.apache.cocoon.xml.xlink.XLinkPipe
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, XLinkHandler, XMLConsumer, XMLPipe, XMLProducer
Direct Known Subclasses:
ExtendedXLinkPipe
public abstract class XLinkPipe
extends AbstractXMLPipe
implements XLinkHandler

This class implements a SAX consumer wrapper that transforms the general SAX semantic into XLink semantics for easier consumption. Classes should extend this class and overwrite the abstract method to consume the XLink events that come in as SAX events. NOTE: this is based on XLink W3C Candidate Recommendation 3 July 2000

Version:
CVS $Id: XLinkPipe.java,v 1.5 2002/02/22 07:03:59 cziegeler Exp $
Author:
Stefano Mazzocchi

Field Summary
static java.lang.String XLINK_ACTUATE
           
static java.lang.String XLINK_ARCROLE
           
static java.lang.String XLINK_FROM
           
static java.lang.String XLINK_HREF
           
static java.lang.String XLINK_LABEL
           
static java.lang.String XLINK_NAMESPACE_URI
           
static java.lang.String XLINK_ROLE
           
static java.lang.String XLINK_SHOW
           
static java.lang.String XLINK_TITLE
           
static java.lang.String XLINK_TO
           
static java.lang.String XLINK_TYPE
           
static java.lang.String XLINK_TYPE_ARC
           
static java.lang.String XLINK_TYPE_EXTENDED
           
static java.lang.String XLINK_TYPE_LOCATOR
           
static java.lang.String XLINK_TYPE_RESOURCE
           
static java.lang.String XLINK_TYPE_SIMPLE
           
static java.lang.String XLINK_TYPE_TITLE
           
 
Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer
contentHandler, lexicalHandler, xmlConsumer
 
Constructor Summary
XLinkPipe()
           
 
Method Summary
 void endArc(java.lang.String uri, java.lang.String name, java.lang.String raw)
           
 void endElement(java.lang.String uri, java.lang.String name, java.lang.String raw)
          Receive notification of the end of an element.
 void endExtendedLink(java.lang.String uri, java.lang.String name, java.lang.String raw)
           
 void endLocator(java.lang.String uri, java.lang.String name, java.lang.String raw)
           
 void linkResource(java.lang.String role, java.lang.String title, java.lang.String label, java.lang.String uri, java.lang.String name, java.lang.String raw, org.xml.sax.Attributes attr)
           
 void linkTitle(java.lang.String uri, java.lang.String name, java.lang.String raw, org.xml.sax.Attributes attr)
           
 void simpleLink(java.lang.String href, java.lang.String role, java.lang.String arcrole, java.lang.String title, java.lang.String show, java.lang.String actuate, java.lang.String uri, java.lang.String name, java.lang.String raw, org.xml.sax.Attributes attr)
           
 void startArc(java.lang.String arcrole, java.lang.String title, java.lang.String show, java.lang.String actuate, java.lang.String from, java.lang.String to, java.lang.String uri, java.lang.String name, java.lang.String raw, org.xml.sax.Attributes attr)
           
 void startElement(java.lang.String uri, java.lang.String name, java.lang.String raw, org.xml.sax.Attributes attr)
          Receive notification of the beginning of an element.
 void startExtendedLink(java.lang.String role, java.lang.String title, java.lang.String uri, java.lang.String name, java.lang.String raw, org.xml.sax.Attributes attr)
           
 void startLocator(java.lang.String href, java.lang.String role, java.lang.String title, java.lang.String label, java.lang.String uri, java.lang.String name, java.lang.String raw, org.xml.sax.Attributes attr)
           
 
Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe
characters, comment, endCDATA, endDocument, endDTD, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startPrefixMapping
 
Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer
recycle, setConsumer, setContentHandler, setLexicalHandler
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable
getLogger, setLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.cocoon.xml.XMLProducer
setConsumer
 

Field Detail

XLINK_NAMESPACE_URI

public static final java.lang.String XLINK_NAMESPACE_URI

XLINK_TYPE

public static final java.lang.String XLINK_TYPE

XLINK_HREF

public static final java.lang.String XLINK_HREF

XLINK_ROLE

public static final java.lang.String XLINK_ROLE

XLINK_ARCROLE

public static final java.lang.String XLINK_ARCROLE

XLINK_TITLE

public static final java.lang.String XLINK_TITLE

XLINK_SHOW

public static final java.lang.String XLINK_SHOW

XLINK_ACTUATE

public static final java.lang.String XLINK_ACTUATE

XLINK_LABEL

public static final java.lang.String XLINK_LABEL

XLINK_FROM

public static final java.lang.String XLINK_FROM

XLINK_TO

public static final java.lang.String XLINK_TO

XLINK_TYPE_SIMPLE

public static final java.lang.String XLINK_TYPE_SIMPLE

XLINK_TYPE_EXTENDED

public static final java.lang.String XLINK_TYPE_EXTENDED

XLINK_TYPE_LOCATOR

public static final java.lang.String XLINK_TYPE_LOCATOR

XLINK_TYPE_ARC

public static final java.lang.String XLINK_TYPE_ARC

XLINK_TYPE_RESOURCE

public static final java.lang.String XLINK_TYPE_RESOURCE

XLINK_TYPE_TITLE

public static final java.lang.String XLINK_TYPE_TITLE
Constructor Detail

XLinkPipe

public XLinkPipe()
Method Detail

startElement

public void startElement(java.lang.String uri,
                         java.lang.String name,
                         java.lang.String raw,
                         org.xml.sax.Attributes attr)
                  throws org.xml.sax.SAXException
Description copied from class: AbstractXMLPipe
Receive notification of the beginning of an element.
Overrides:
startElement in class AbstractXMLPipe
Following copied from class: org.apache.cocoon.xml.AbstractXMLPipe
Parameters:
uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
loc - The local name (without prefix), or the empty string if Namespace processing is not being performed.
raw - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.
a - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

endElement

public void endElement(java.lang.String uri,
                       java.lang.String name,
                       java.lang.String raw)
                throws org.xml.sax.SAXException
Description copied from class: AbstractXMLPipe
Receive notification of the end of an element.
Overrides:
endElement in class AbstractXMLPipe
Following copied from class: org.apache.cocoon.xml.AbstractXMLPipe
Parameters:
uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
loc - The local name (without prefix), or the empty string if Namespace processing is not being performed.
raw - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.

simpleLink

public void simpleLink(java.lang.String href,
                       java.lang.String role,
                       java.lang.String arcrole,
                       java.lang.String title,
                       java.lang.String show,
                       java.lang.String actuate,
                       java.lang.String uri,
                       java.lang.String name,
                       java.lang.String raw,
                       org.xml.sax.Attributes attr)
                throws org.xml.sax.SAXException
Specified by:
simpleLink in interface XLinkHandler

startExtendedLink

public void startExtendedLink(java.lang.String role,
                              java.lang.String title,
                              java.lang.String uri,
                              java.lang.String name,
                              java.lang.String raw,
                              org.xml.sax.Attributes attr)
                       throws org.xml.sax.SAXException
Specified by:
startExtendedLink in interface XLinkHandler

startLocator

public void startLocator(java.lang.String href,
                         java.lang.String role,
                         java.lang.String title,
                         java.lang.String label,
                         java.lang.String uri,
                         java.lang.String name,
                         java.lang.String raw,
                         org.xml.sax.Attributes attr)
                  throws org.xml.sax.SAXException
Specified by:
startLocator in interface XLinkHandler

startArc

public void startArc(java.lang.String arcrole,
                     java.lang.String title,
                     java.lang.String show,
                     java.lang.String actuate,
                     java.lang.String from,
                     java.lang.String to,
                     java.lang.String uri,
                     java.lang.String name,
                     java.lang.String raw,
                     org.xml.sax.Attributes attr)
              throws org.xml.sax.SAXException
Specified by:
startArc in interface XLinkHandler

linkResource

public void linkResource(java.lang.String role,
                         java.lang.String title,
                         java.lang.String label,
                         java.lang.String uri,
                         java.lang.String name,
                         java.lang.String raw,
                         org.xml.sax.Attributes attr)
                  throws org.xml.sax.SAXException
Specified by:
linkResource in interface XLinkHandler

linkTitle

public void linkTitle(java.lang.String uri,
                      java.lang.String name,
                      java.lang.String raw,
                      org.xml.sax.Attributes attr)
               throws org.xml.sax.SAXException
Specified by:
linkTitle in interface XLinkHandler

endExtendedLink

public void endExtendedLink(java.lang.String uri,
                            java.lang.String name,
                            java.lang.String raw)
                     throws org.xml.sax.SAXException
Specified by:
endExtendedLink in interface XLinkHandler

endLocator

public void endLocator(java.lang.String uri,
                       java.lang.String name,
                       java.lang.String raw)
                throws org.xml.sax.SAXException
Specified by:
endLocator in interface XLinkHandler

endArc

public void endArc(java.lang.String uri,
                   java.lang.String name,
                   java.lang.String raw)
            throws org.xml.sax.SAXException
Specified by:
endArc in interface XLinkHandler
Overview  Package   Class  Tree  Deprecated  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright � 1999-2002 Apache Software Foundation. All Rights Reserved.