org.fourthline.lemma.anchor

Class CitationAnchor

java.lang.Object

org.seamless.xml.DOMElement<org.seamless.xhtml.XHTMLElement,org.seamless.xhtml.XHTMLElement>

org.seamless.xhtml.XHTMLElement

org.seamless.xhtml.Anchor

org.fourthline.lemma.anchor.CitationAnchor

public class CitationAnchor
extends org.seamless.xhtml.Anchor

Adapter which extends the regular DOM anchor, provides access to common options.

Author:

Christian Bauer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CitationAnchor.OptionKey The most common option (keys) of citation anchors.

Nested classes/interfaces inherited from class org.seamless.xml.DOMElement

org.seamless.xml.DOMElement.ArrayBuilder<T extends org.seamless.xml.DOMElement>, org.seamless.xml.DOMElement.Builder<T extends org.seamless.xml.DOMElement>

Field Summary

Fields inherited from class org.seamless.xhtml.XHTMLElement

XPATH_PREFIX

Fields inherited from class org.seamless.xml.DOMElement

CHILD_BUILDER, PARENT_BUILDER

Constructor Summary

Constructors

Constructor and Description
CitationAnchor(XPath xpath, org.seamless.xhtml.Anchor anchor)
CitationAnchor(XPath xpath, Element element)

Method Summary

Modifier and Type	Method and Description
static CitationAnchor[]	findCitationAnchors(XPath xpath, org.seamless.xhtml.XHTMLElement start, String type)
static CitationAnchor[]	findCitationAnchors(XPath xpath, org.seamless.xhtml.XHTML input, String type)
AnchorAddress	getAddress()
org.seamless.xhtml.Option	getOption(CitationAnchor.OptionKey key)
String	getOutputClasses()
String	getOutputIdentifier()

Methods inherited from class org.seamless.xhtml.Anchor

getHref, getType, setHref, setType, toString

Methods inherited from class org.seamless.xhtml.XHTMLElement

createChild, createChildBuilder, createParentBuilder, findAllAnchors, findAllAnchors, findAllAnchors, findChildren, findChildrenWithClass, getAttribute, getChildren, getClasses, getConstant, getFirstChild, getId, getOption, getOptions, getTitle, prefix, setAttribute, setAttribute, setClasses, setClasses, setContent, setId, setTitle

Methods inherited from class org.seamless.xml.DOMElement

adoptOrImport, appendChild, createChild, createChild, findChildren, findChildWithIdentifier, getAttribute, getChildren, getChildren, getContent, getElementName, getFirstChild, getParent, getRequiredChild, getW3CElement, getXpath, getXPathChildElement, getXPathChildElements, getXPathElements, getXPathParentElement, getXPathParentElements, getXPathResult, getXPathResult, getXPathString, removeChild, removeChildren, replaceChild, replaceEqualChild, toSimpleXMLString

Methods inherited from class java.lang.Object

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

Constructor Detail

CitationAnchor

public CitationAnchor(XPath xpath,
                      org.seamless.xhtml.Anchor anchor)

CitationAnchor

public CitationAnchor(XPath xpath,
                      Element element)

Method Detail

getAddress

public AnchorAddress getAddress()

getOption

public org.seamless.xhtml.Option getOption(CitationAnchor.OptionKey key)

getOutputIdentifier

public String getOutputIdentifier()

Returns:

The value of the id attribute of the anchor, or if not present the id of the given address.

getOutputClasses

public String getOutputClasses()

Returns:

Any given class class attribute value (if present), in addition the name of the address scheme.

findCitationAnchors

public static CitationAnchor[] findCitationAnchors(XPath xpath,
                                                   org.seamless.xhtml.XHTML input,
                                                   String type)

findCitationAnchors

public static CitationAnchor[] findCitationAnchors(XPath xpath,
                                                   org.seamless.xhtml.XHTMLElement start,
                                                   String type)