org.xbrlapi
Interface Entity

All Superinterfaces:

Comparable<XML>, ContextComponent, Fragment, Serializable, XML

All Known Implementing Classes:

EntityImpl

public interface Entity
extends ContextComponent

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

List<LabelResource>	getAllEntityLabels()
List<LabelResource>	getEntityLabels()
List<EntityResource>	getEntityResources()
URI	getIdentifierScheme() Get the entity identifier scheme.
String	getIdentifierValue()
Segment	getSegment() Get the segment of the entity
boolean	hasSegment()

Methods inherited from interface org.xbrlapi.ContextComponent

getContext

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

URI getIdentifierScheme()
                        throws XBRLException

Get the entity identifier scheme.

Returns:

the entity identifier scheme URI

Throws:

XBRLException

getIdentifierValue

String getIdentifierValue()
                          throws XBRLException

Returns:

the entity identification value as an XML Schema token (basically eliminates unnecessary white spaces but see XML Schema datatypes for the gory details.)

Throws:

XBRLException

getSegment

Segment getSegment()
                   throws XBRLException

Get the segment of the entity

Returns:

the segment information for the entity or null if the entity does not include segment information.

Throws:

XBRLException

hasSegment

boolean hasSegment()
                   throws XBRLException

Returns:

true iff the entity has explicit segment content.

Throws:

XBRLException

getEntityResources

List<EntityResource> getEntityResources()
                                        throws XBRLException

Returns:

a list of all the entity resources with the entity scheme and value of this entity fragment. The list is empty if there are no entity resources that match the relevant criteria. Note that the entity identifier value is trimmed before being compared to the identifier value in entity resources. If you are failing to get matches, avoid leading or trailing spaces in entity identification resource metadata value attributes.

Throws:

XBRLException

getEntityLabels

List<LabelResource> getEntityLabels()
                                    throws XBRLException

Returns:

the list of labels for the entity identified by this fragment, NOT taking into account the labels for the given identifier and the labels for any equivalent identifiers.

Throws:

XBRLException

getAllEntityLabels

List<LabelResource> getAllEntityLabels()
                                       throws XBRLException

Returns:

the list of labels for the entity identified by this fragment, taking into account the labels for the given identifier and the labels for any equivalent identifiers.

Throws:

XBRLException