Package ro.sync.ecss.extensions.api.link

Class ElementLocator

  • Direct Known Subclasses:
    DITAElementLocator, DITAMapKeyDefElementLocator, IDElementLocator, XPointerElementLocator
    @API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class ElementLocator
extends java.lang.Object
    Base class for custom elements locators used to locate an element based on a link. The source XML is parsed and notifications will be forwarded to ElementLocator objects in order for the references to be resolved.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String link
      The link to be used to identify the element.

    • Constructor Summary

      Constructors 
      Constructor Description
      ElementLocator​(java.lang.String link)
      Constructor.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract void endElement​(java.lang.String uri, java.lang.String localName, java.lang.String qName)
      Notification received when the end of an element has been encountered.
      abstract boolean startElement​(java.lang.String uri, java.lang.String localName, java.lang.String qName, Attr[] atts)
      Notification received when the beginning of an element has been encountered.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • link

        protected final java.lang.String link
        The link to be used to identify the element.

    • Constructor Detail

      • ElementLocator

        public ElementLocator​(java.lang.String link)
        Constructor.
        Parameters:
        link - The link to be used to identify the element.

    • Method Detail

      • startElement

        public abstract boolean startElement​(java.lang.String uri,
                                     java.lang.String localName,
                                     java.lang.String qName,
                                     Attr[] atts)
        Notification received when the beginning of an element has been encountered. This method is invoked at the beginning of every element in the XML document; an event will be fired for every startElement (even when the element is empty).
        Parameters:
        uri - the namespace URI, or the empty string if the element has no namespace URI or if namespace processing is not being performed
        localName - the local name of the element
        qName - the qualified name of the element
        atts - an array with the attributes attached to the element. If there are no attributes, it shall be empty. The attributes are represented as Attr objects.
        Returns:
        true if the current element is indicated by the link.

      • endElement

        public abstract void endElement​(java.lang.String uri,
                                java.lang.String localName,
                                java.lang.String qName)
        Notification received when the end of an element has been encountered. This method is invoked at the end of every element in the XML document; an event will be fired for every endElement (even when the element is empty).
        Parameters:
        uri - the namespace URI, or the empty string if the element has no namespace URI or if namespace processing is not being performed
        localName - the local name of the element
        qName - the qualified XML name of the element