org.xbrlapi
Interface EntityResource

All Superinterfaces:

ArcEnd, Comparable<XML>, ExtendedLinkContent, Fragment, MixedContentResource, Resource, Serializable, Xlink, XML

All Known Implementing Classes:

EntityResourceImpl

public interface EntityResource
extends MixedContentResource

Defines the functionality for the custom entity resource: a extended link resource that has a 1:1 association with a given entity identifier.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

List<Entity>	getEntities()
List<Entity>	getEntities(URI uri)
Set<EntityResource>	getEquivalents()
String	getIdentifierScheme()
String	getIdentifierValue()

Methods inherited from interface org.xbrlapi.MixedContentResource

getContentAsNodeList, getContentAsXHTMLString

Methods inherited from interface org.xbrlapi.Resource

getResourceRole

Methods inherited from interface org.xbrlapi.ArcEnd

getArcEndId, getArcsFrom, getArcsFromWithArcrole, getArcsTo, getArcsToWithArcrole, getLabel, getRole

Methods inherited from interface org.xbrlapi.ExtendedLinkContent

getExtendedLink

Methods inherited from interface org.xbrlapi.Xlink

getAttribute, getAttribute, getTitleAttribute, getTitleElement, getTitleElements, getXlinkType

Methods inherited from interface org.xbrlapi.Fragment

appendElementSchemeXPointer, appendID, getAllChildren, getAllChildrenIndices, getAncestorOrSelf, getChild, getChildren, getChildren, getChildrenIndices, getDataRootElement, getElementSchemeXPointerExpression, getIDXPointerExpression, getLabels, getLabels, getLabels, getLabelsWithLanguage, getLabelsWithLanguageAndResourceRole, getLabelsWithLanguageAndResourceRoleAndLinkRole, getLabelsWithResourceRole, getLanguage, getLanguage, getLanguageName, getLanguageName, getLocalname, getLocalnameFromQName, getNamespace, getNamespaceFromQName, getParent, getParentElement, getParentIndex, getPrefixFromQName, getReferences, getReferencesWithLanguage, getReferencesWithLanguageAndResourceRoleAndLinkRole, getReferencesWithLanguageAndRole, getReferencesWithResourceRole, getReferencingLocators, getSequenceToParentElement, getSequenceToParentElementAsString, getSimpleLinks, getURI, getXPath, getXPointerExpression, isAncestorOf, isChild, isNewFragment, isRoot, setParentIndex, setSequenceToParentElement, setURI

Methods inherited from interface org.xbrlapi.XML

appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getIdentifierScheme

String getIdentifierScheme()
                           throws XBRLException

Returns:

the entity identifier scheme URI

Throws:

XBRLException

getIdentifierValue

String getIdentifierValue()
                          throws XBRLException

Returns:

the entity identifier value token

Throws:

XBRLException

getEquivalents

Set<EntityResource> getEquivalents()
                                   throws XBRLException

Returns:

a list of all equivalent entity resources, including this entity resource that is naturally equivalent to itself.

Throws:

XBRLException

getEntities

List<Entity> getEntities()
                         throws XBRLException

Returns:

a list of entity identifier fragments from the contexts the data store (or an empty fragment list if there are none matching this entity resource).

Throws:

XBRLException

getEntities

List<Entity> getEntities(URI uri)
                         throws XBRLException

Parameters:

uri - The URI of the document to get the entities from

Returns:

a list of entity identifier fragments from the contexts in the specified document (or an empty fragment list if there are none matching this entity resource).

Throws:

XBRLException