org.xbrlapi.impl
Class EntityImpl

java.lang.Object
  org.xbrlapi.impl.XMLImpl
      org.xbrlapi.impl.FragmentImpl
          org.xbrlapi.impl.ContextComponentImpl
              org.xbrlapi.impl.EntityImpl

All Implemented Interfaces:

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

public class EntityImpl
extends ContextComponentImpl
implements Entity

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.impl.XMLImpl

logger

Constructor Summary

EntityImpl()

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 class org.xbrlapi.impl.ContextComponentImpl

getContext

Methods inherited from class org.xbrlapi.impl.FragmentImpl

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 class org.xbrlapi.impl.XMLImpl

appendMetadataElement, compareTo, equals, finalize, 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 class java.lang.Object

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

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

Constructor Detail

EntityImpl

public EntityImpl()

Method Detail

getIdentifierScheme

public URI getIdentifierScheme()
                        throws XBRLException

Description copied from interface: Entity

Get the entity identifier scheme.

Specified by:

getIdentifierScheme in interface Entity

Returns:

the entity identifier scheme URI

Throws:

XBRLException

See Also:

Entity.getIdentifierScheme()

getIdentifierValue

public String getIdentifierValue()
                          throws XBRLException

Specified by:

getIdentifierValue in interface Entity

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

See Also:

Entity.getIdentifierValue()

getSegment

public Segment getSegment()
                   throws XBRLException

Description copied from interface: Entity

Get the segment of the entity

Specified by:

getSegment in interface Entity

Returns:

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

Throws:

XBRLException

See Also:

Entity.getSegment()

hasSegment

public boolean hasSegment()
                   throws XBRLException

Specified by:

hasSegment in interface Entity

Returns:

true iff the entity has explicit segment content.

Throws:

XBRLException

See Also:

Entity.hasSegment()

getEntityResources

public List<EntityResource> getEntityResources()
                                        throws XBRLException

Specified by:

getEntityResources in interface Entity

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

See Also:

Entity.getEntityResources()

getEntityLabels

public List<LabelResource> getEntityLabels()
                                    throws XBRLException

Specified by:

getEntityLabels in interface Entity

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

See Also:

Entity.getEntityLabels()

getAllEntityLabels

public List<LabelResource> getAllEntityLabels()
                                       throws XBRLException

Specified by:

getAllEntityLabels in interface Entity

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

See Also:

Entity.getAllEntityLabels()