|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.ihr.xbrl.om.XMLFragment
com.ihr.xbrl.om.exLinks.XLinkElement
com.ihr.xbrl.om.exLinks.XBRLExtendedLink
public abstract class XBRLExtendedLink
| Field Summary | |
|---|---|
static java.lang.String |
standard_role_URI
The standard role URI http://www.xbrl.org/2003/role/link |
| Fields inherited from class com.ihr.xbrl.om.exLinks.XLinkElement |
|---|
actuate, ACTUATE, ARC, arcrole, ARCROLE, ETITLE, EXTENDED, from, FROM, href, HREF, label, LABEL, LOCATOR, RESOURCE, role, ROLE, show, SHOW, SIMPLE, title, TITLE, to, TO, type, TYPE |
| Fields inherited from class com.ihr.xbrl.om.XMLFragment |
|---|
CONCEPT_LABEL, CONCEPT_QNAME, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, idQName, NO_POSITION, OrderComparator, PERIOD_TYPE, PERIOD_VALUE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER |
| Method Summary | |
|---|---|
void |
addDocumentation(XBRLDocumentation doc)
Adds a new XBRLDocumentation object to this object |
void |
addRelationship(XBRLRelationship relationship)
|
void |
addResource(XBRLResource resource)
This method adds a XBRLResource to the Extended Link container. |
void |
clear()
Frees-up used memory This method should not be invoqued on live objects in the DTS. |
void |
clearCaches()
Used to clear memory used during the DTS loading process. |
static XBRLExtendedLink |
createExtendedLink(XBRLDocument parent,
DTSBase base)
|
static XBRLExtendedLink |
createExtendedLink(XBRLDocument parent,
javax.xml.namespace.QName rootElementName,
XBRLRoleType role)
|
static XBRLExtendedLink |
createExtendedLink(XBRLDocument parent,
net.sf.saxon.s9api.XdmNode node)
|
void |
discoverDTS(XBRLDTSDocument parent)
Fires the rules of DTS Discovery for this object |
boolean |
equals(java.lang.Object other)
Sets a new XPathFunctionResolver for this object |
org.jdom.Element |
generateNode(boolean relativize,
java.net.URI base)
Serializes to a jdom Element the representation of the properties of this Information Item This method should be called from classes derived from this class |
java.util.Iterator<XBRLArcroleType> |
getArcroles()
Access to all used arcroles. |
java.util.Iterator<XBRLArc> |
getArcs()
Return an Iterator object over all arcs in the extended link. |
java.util.Iterator<XBRLAttribute> |
getAttributes()
Access to the [Attributes] property |
java.util.Iterator<XBRLDocumentation> |
getDocumentation()
Access to the [Documentation] property |
DTSBase |
getDTSBase()
|
java.net.URI |
getDTSKey()
Provides a key that can be used to index the document in the cache |
java.util.Iterator<XMLFragment> |
getElements()
For complex type resources this returns an iterator with all children XML fragments Tthis method may be overwriten by other classes in the hierarchy |
abstract java.lang.String |
getExtendedLinkTypeName()
Returns a localized constant string indicating the extended link type |
java.lang.String |
getFriendlyName()
Returns a string description that represents the element content in a form that users can understand. |
javax.xml.namespace.QName |
getLinkbaseType()
Access to the [linkbaseType] property This is the QName of the extended link element which is the root ot this extended link |
java.util.Iterator<XBRLLocator> |
getLocators()
Access to all locators in an extended link. |
int |
getNumberOfResources()
Returns how many resources exists in this extended link |
XBRLDocument |
getParent()
Access to the [Parent] property |
java.util.Iterator<XBRLRelationship> |
getRelationships()
Access to the [Relationships] information item |
java.util.Iterator<XBRLResource> |
getResources()
Return an iterator over all resources that exist on this extended link. |
XBRLRoleType |
getRoleType()
Access to the [Role Type] property of this object Validates this extended link QName in on the used on list of the roleType |
abstract javax.xml.namespace.QName |
getStaticLinkbaseType()
This function MUST be implemented by classes derived from this class |
int |
hashCode()
|
void |
removeDocumentation(XBRLDocumentation doc)
Remove a XBRLDocumentation object to this object |
boolean |
removeRelationship(XBRLRelationship relationship)
|
void |
removeResource(XBRLResource resource)
|
void |
setDTSBase(DTSBase base)
|
void |
setParent(XBRLDocument parent)
Sets the parent of this extended link |
void |
setRole(java.lang.String newRole)
Sets the value of the xlink:role attribute to a specific value |
void |
setRoleType(XBRLRoleType newRoleType)
|
XBRLValidationReport |
validate(XBRLCoreProcessor proc)
Performs XLink valiadtion at the arcs level |
abstract void |
validateNewRelationship(XBRLRelationship rel)
|
boolean |
wouldBeDuplicateArc(XBRLRelationship rel)
Checks wether or not the relationship in the parameter will be a duplicate relationship in this extended link |
| Methods inherited from class com.ihr.xbrl.om.exLinks.XLinkElement |
|---|
getActuate, getArcrole, getFromTxt, getHRef, getLabel, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.ihr.xbrl.om.exLinks.XBRLAllowsDocumentation |
|---|
getContainer |
| Methods inherited from interface com.ihr.xbrl.om.XMLHasParent |
|---|
addXMLChild, getBase, removeXMLChild, setParent |
| Field Detail |
|---|
public static final java.lang.String standard_role_URI
| Method Detail |
|---|
public java.net.URI getDTSKey()
XBRLDTSDocument
getDTSKey in interface XBRLDTSDocument
public void clear()
throws java.lang.Throwable
XMLFragmentThis method should not be invoqued on live objects in the DTS. It is automatically invoqued by the API when an object is no longer used and referenced by other objects. It is save not to call it directly.
clear in interface XBRLDTSDocumentclear in class XMLFragmentjava.lang.Throwablepublic XBRLDocument getParent()
getParent in interface XMLHasParentgetParent in class XMLFragmentpublic void setParent(XBRLDocument parent)
parent - the new XBRLDocument that will be the parent
public void setDTSBase(DTSBase base)
throws XBRLInconsistentDTSException
XBRLInconsistentDTSExceptionpublic DTSBase getDTSBase()
public boolean equals(java.lang.Object other)
XMLFragment
equals in class XMLFragmentpublic int hashCode()
hashCode in class XMLFragment
public static XBRLExtendedLink createExtendedLink(XBRLDocument parent,
DTSBase base)
throws XBRLInconsistentDTSException
parent - XBRLDocumentbase - DTSBase
XBRLInconsistentDTSException
public static XBRLExtendedLink createExtendedLink(XBRLDocument parent,
javax.xml.namespace.QName rootElementName,
XBRLRoleType role)
throws XBRLInconsistentDTSException
XBRLInconsistentDTSException
public static XBRLExtendedLink createExtendedLink(XBRLDocument parent,
net.sf.saxon.s9api.XdmNode node)
public void discoverDTS(XBRLDTSDocument parent)
throws DTSDiscoveryException,
com.rs.lic.LicenseVerificationException
XBRLDTSDocument
discoverDTS in interface XBRLDTSDocumentDTSDiscoveryException
com.rs.lic.LicenseVerificationExceptionpublic abstract javax.xml.namespace.QName getStaticLinkbaseType()
public abstract java.lang.String getExtendedLinkTypeName()
public javax.xml.namespace.QName getLinkbaseType()
public java.util.Iterator<XBRLDocumentation> getDocumentation()
public void addDocumentation(XBRLDocumentation doc)
XBRLAllowsDocumentation
addDocumentation in interface XBRLAllowsDocumentationpublic void removeDocumentation(XBRLDocumentation doc)
XBRLAllowsDocumentation
removeDocumentation in interface XBRLAllowsDocumentationpublic java.util.Iterator<XBRLAttribute> getAttributes()
getAttributes in class XMLFragmentpublic XBRLRoleType getRoleType()
XBRLValidationExceptionpublic void setRoleType(XBRLRoleType newRoleType)
public void setRole(java.lang.String newRole)
XLinkElement
setRole in class XLinkElement
public void addRelationship(XBRLRelationship relationship)
throws XBRLInconsistentDTSException
relationship -
XBRLValidationException
XBRLValidationException
XBRLInconsistentDTSException
public abstract void validateNewRelationship(XBRLRelationship rel)
throws XBRLValidationException
XBRLValidationException
public boolean removeRelationship(XBRLRelationship relationship)
throws XBRLInconsistentDTSException
relationship -
XBRLInconsistentDTSException
XBRLValidationExceptionpublic java.lang.String getFriendlyName()
XMLFragmentRemarks, this method may return very long names not suitable for user interface
getFriendlyName in class XMLFragmentpublic java.util.Iterator<XBRLArcroleType> getArcroles()
XBRLValidationExceptionpublic java.util.Iterator<XBRLRelationship> getRelationships()
XBRLValidationException
XBRLValidationExceptionpublic XBRLValidationReport validate(XBRLCoreProcessor proc)
public org.jdom.Element generateNode(boolean relativize,
java.net.URI base)
throws XBRLSerializationException
XMLFragment
generateNode in class XLinkElementrelativize - boolean indicating if URIs should be relativized to the base URI (see next argument)base - the URI to which some attributes of this object should be relativided
XBRLSerializationException
public boolean wouldBeDuplicateArc(XBRLRelationship rel)
throws XBRLValidationException
rel - the relationship that is not in this link and will be tested
XBRLValidationException
public java.util.Iterator<XBRLArc> getArcs()
throws XBRLValidationException
XBRLValidationException - If there are unrecoverable XBRL errors in the arcpublic java.util.Iterator<XBRLResource> getResources()
XBRLValidationExceptionpublic int getNumberOfResources()
XBRLValidationException
public void addResource(XBRLResource resource)
throws XBRLDuplicateException
Try to avoid calling this method directly and use the setParent(XBRLExtendedLink) method of the resource instead.
resource -
XBRLDuplicateExceptionpublic void removeResource(XBRLResource resource)
resource - public java.util.Iterator<XBRLLocator> getLocators()
public java.util.Iterator<XMLFragment> getElements()
XMLFragment
getElements in class XMLFragmentpublic void clearCaches()
For internal purposes only
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||