org.xbrlapi.xlink
Class CustomLinkRecogniser

java.lang.Object
  org.xbrlapi.xlink.CustomLinkRecogniser

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

XBRLCustomLinkRecogniserImpl

public abstract class CustomLinkRecogniser
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

CustomLinkRecogniser()

Method Summary

boolean	equals(Object obj)
String	getActuate(String namespaceURI, String lName, String qName, Attributes attrs) Get the simple link actuate equivalent if it exists
String	getArcrole(String namespaceURI, String lName, String qName, Attributes attrs) Get the simple link arcrole equivalent if it exists
abstract String	getHref(String namespaceURI, String lName, String qName, Attributes attrs) Get the href equivalent for the link
String	getRole(String namespaceURI, String lName, String qName, Attributes attrs) Get the simple link role equivalent if it exists
String	getShow(String namespaceURI, String lName, String qName, Attributes attrs) Get the simple link show equivalent if it exists
String	getTitle(String namespaceURI, String lName, String qName, Attributes attrs) Get the simple link title attribute equivalent if it exists
int	hashCode()
abstract boolean	isLink(String namespaceURI, String lName, String qName, Attributes attrs) Returns true if the element with the supplied characteristics is a custom simple link.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomLinkRecogniser

public CustomLinkRecogniser()

Method Detail

isLink

public abstract boolean isLink(String namespaceURI,
                               String lName,
                               String qName,
                               Attributes attrs)

Returns true if the element with the supplied characteristics is a custom simple link. Importantly his method can be called from a SAX start element event and from a SAX end element event.

Parameters:

namespaceURI - The namespace of the element.

lName - The localname of the element.

qName - The QName of the element.

attrs - The attributes of the element.

Returns:

true if the element is a custom simple link and false otherwise.

getHref

public abstract String getHref(String namespaceURI,
                               String lName,
                               String qName,
                               Attributes attrs)
                        throws XLinkException

Get the href equivalent for the link

Parameters:

namespaceURI -

lName -

qName -

attrs -

Returns:

the href

Throws:

XLinkException

getRole

public String getRole(String namespaceURI,
                      String lName,
                      String qName,
                      Attributes attrs)

Get the simple link role equivalent if it exists

Parameters:

namespaceURI -

lName -

qName -

attrs -

Returns:

the role or null if it does not exist

Throws:

XLinkException

getArcrole

public String getArcrole(String namespaceURI,
                         String lName,
                         String qName,
                         Attributes attrs)

Get the simple link arcrole equivalent if it exists

Parameters:

namespaceURI -

lName -

qName -

attrs -

Returns:

the arcrole or null if it does not exist

Throws:

XLinkException

getTitle

public String getTitle(String namespaceURI,
                       String lName,
                       String qName,
                       Attributes attrs)

Get the simple link title attribute equivalent if it exists

Parameters:

namespaceURI -

lName -

qName -

attrs -

Returns:

the title or null if it does not exist

Throws:

XLinkException

getShow

public String getShow(String namespaceURI,
                      String lName,
                      String qName,
                      Attributes attrs)

Get the simple link show equivalent if it exists

Parameters:

namespaceURI -

lName -

qName -

attrs -

Returns:

the show or null if it does not exist

Throws:

XLinkException

getActuate

public String getActuate(String namespaceURI,
                         String lName,
                         String qName,
                         Attributes attrs)

Get the simple link actuate equivalent if it exists

Parameters:

namespaceURI -

lName -

qName -

attrs -

Returns:

the actuate or null if it does not exist

Throws:

XLinkException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)