org.apache.cocoon.xml.xlink
Class XLinkPipe

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.xml.AbstractXMLProducer
          extended byorg.apache.cocoon.xml.AbstractXMLPipe
              extended byorg.apache.cocoon.xml.xlink.XLinkPipe
All Implemented Interfaces:
ContentHandler, LexicalHandler, Poolable, Recyclable, org.apache.cocoon.xml.xlink.XLinkHandler, XMLConsumer, org.apache.cocoon.xml.XMLConsumer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer
Direct Known Subclasses:
ExtendedXLinkPipe

public abstract class XLinkPipe
extends AbstractXMLPipe
implements org.apache.cocoon.xml.xlink.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:
$Id: XLinkPipe.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
static String XLINK_ACTUATE
           
static String XLINK_ARCROLE
           
static String XLINK_FROM
           
static String XLINK_HREF
           
static String XLINK_LABEL
           
static String XLINK_NAMESPACE_URI
           
static String XLINK_ROLE
           
static String XLINK_SHOW
           
static String XLINK_TITLE
           
static String XLINK_TO
           
static String XLINK_TYPE
           
static String XLINK_TYPE_ARC
           
static String XLINK_TYPE_EXTENDED
           
static String XLINK_TYPE_LOCATOR
           
static String XLINK_TYPE_RESOURCE
           
static String XLINK_TYPE_SIMPLE
           
static String XLINK_TYPE_TITLE
           
 
Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer
contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer
 
Constructor Summary
XLinkPipe()
           
 
Method Summary
 void endArc(String uri, String name, String raw)
           
 void endElement(String uri, String name, String raw)
          Receive notification of the end of an element.
 void endExtendedLink(String uri, String name, String raw)
           
 void endLocator(String uri, String name, String raw)
           
 void linkResource(String role, String title, String label, String uri, String name, String raw, Attributes attr)
           
 void linkTitle(String uri, String name, String raw, Attributes attr)
           
 void simpleLink(String href, String role, String arcrole, String title, String show, String actuate, String uri, String name, String raw, Attributes attr)
           
 void startArc(String arcrole, String title, String show, String actuate, String from, String to, String uri, String name, String raw, Attributes attr)
           
 void startElement(String uri, String name, String raw, Attributes attr)
          Receive notification of the beginning of an element.
 void startExtendedLink(String role, String title, String uri, String name, String raw, Attributes attr)
           
 void startLocator(String href, String role, String title, String label, String uri, String name, String raw, 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.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
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 String XLINK_NAMESPACE_URI
See Also:
Constant Field Values

XLINK_TYPE

public static final String XLINK_TYPE
See Also:
Constant Field Values

XLINK_HREF

public static final String XLINK_HREF
See Also:
Constant Field Values

XLINK_ROLE

public static final String XLINK_ROLE
See Also:
Constant Field Values

XLINK_ARCROLE

public static final String XLINK_ARCROLE
See Also:
Constant Field Values

XLINK_TITLE

public static final String XLINK_TITLE
See Also:
Constant Field Values

XLINK_SHOW

public static final String XLINK_SHOW
See Also:
Constant Field Values

XLINK_ACTUATE

public static final String XLINK_ACTUATE
See Also:
Constant Field Values

XLINK_LABEL

public static final String XLINK_LABEL
See Also:
Constant Field Values

XLINK_FROM

public static final String XLINK_FROM
See Also:
Constant Field Values

XLINK_TO

public static final String XLINK_TO
See Also:
Constant Field Values

XLINK_TYPE_SIMPLE

public static final String XLINK_TYPE_SIMPLE
See Also:
Constant Field Values

XLINK_TYPE_EXTENDED

public static final String XLINK_TYPE_EXTENDED
See Also:
Constant Field Values

XLINK_TYPE_LOCATOR

public static final String XLINK_TYPE_LOCATOR
See Also:
Constant Field Values

XLINK_TYPE_ARC

public static final String XLINK_TYPE_ARC
See Also:
Constant Field Values

XLINK_TYPE_RESOURCE

public static final String XLINK_TYPE_RESOURCE
See Also:
Constant Field Values

XLINK_TYPE_TITLE

public static final String XLINK_TYPE_TITLE
See Also:
Constant Field Values
Constructor Detail

XLinkPipe

public XLinkPipe()
Method Detail

startElement

public void startElement(String uri,
                         String name,
                         String raw,
                         Attributes attr)
                  throws SAXException
Description copied from class: AbstractXMLPipe
Receive notification of the beginning of an element.

Specified by:
startElement in interface ContentHandler
Overrides:
startElement in class 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.
name - 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.
attr - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.
Throws:
SAXException

endElement

public void endElement(String uri,
                       String name,
                       String raw)
                throws SAXException
Description copied from class: AbstractXMLPipe
Receive notification of the end of an element.

Specified by:
endElement in interface ContentHandler
Overrides:
endElement in class 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.
name - 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.
Throws:
SAXException

simpleLink

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

startExtendedLink

public void startExtendedLink(String role,
                              String title,
                              String uri,
                              String name,
                              String raw,
                              Attributes attr)
                       throws SAXException
Specified by:
startExtendedLink in interface org.apache.cocoon.xml.xlink.XLinkHandler
Throws:
SAXException

startLocator

public void startLocator(String href,
                         String role,
                         String title,
                         String label,
                         String uri,
                         String name,
                         String raw,
                         Attributes attr)
                  throws SAXException
Specified by:
startLocator in interface org.apache.cocoon.xml.xlink.XLinkHandler
Throws:
SAXException

startArc

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

linkResource

public void linkResource(String role,
                         String title,
                         String label,
                         String uri,
                         String name,
                         String raw,
                         Attributes attr)
                  throws SAXException
Specified by:
linkResource in interface org.apache.cocoon.xml.xlink.XLinkHandler
Throws:
SAXException

linkTitle

public void linkTitle(String uri,
                      String name,
                      String raw,
                      Attributes attr)
               throws SAXException
Specified by:
linkTitle in interface org.apache.cocoon.xml.xlink.XLinkHandler
Throws:
SAXException

endExtendedLink

public void endExtendedLink(String uri,
                            String name,
                            String raw)
                     throws SAXException
Specified by:
endExtendedLink in interface org.apache.cocoon.xml.xlink.XLinkHandler
Throws:
SAXException

endLocator

public void endLocator(String uri,
                       String name,
                       String raw)
                throws SAXException
Specified by:
endLocator in interface org.apache.cocoon.xml.xlink.XLinkHandler
Throws:
SAXException

endArc

public void endArc(String uri,
                   String name,
                   String raw)
            throws SAXException
Specified by:
endArc in interface org.apache.cocoon.xml.xlink.XLinkHandler
Throws:
SAXException


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.