org.xbrlapi.aspects
Class EntityIdentifierAspect

java.lang.Object
  org.xbrlapi.aspects.BaseAspect
      org.xbrlapi.aspects.ContextAspect
          org.xbrlapi.aspects.EntityIdentifierAspect

All Implemented Interfaces:

Serializable, Aspect

public class EntityIdentifierAspect
extends ContextAspect
implements Aspect

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Nested Class Summary

class

EntityIdentifierAspect.Transformer

Field Summary

static String

TYPE

Fields inherited from class org.xbrlapi.aspects.BaseAspect

values

Fields inherited from interface org.xbrlapi.aspects.Aspect

ENTITY_IDENTIFIER, LOCATION, PERIOD, SCENARIO, SEGMENT, UNIT

Constructor Summary

EntityIdentifierAspect(AspectModel aspectModel)

Method Summary

boolean	equals(Object obj)
Entity	getFragmentFromStore(Fact fact)
String	getType()
EntityIdentifierAspectValue	getValue(Fact fact)
int	hashCode()
protected void	initialize()

Methods inherited from class org.xbrlapi.aspects.ContextAspect

getContextFromStore, getKey

Methods inherited from class org.xbrlapi.aspects.BaseAspect

addFact, addValue, clearFacts, clearSelectionCriterion, getAncestorCount, getAspectModel, getAxis, getDescendantCount, getFacts, getFragment, getIterator, getLabelFromElement, getLabelFromElements, getMatchingFacts, getSelectionCriterion, getTransformer, getValue, getValues, getValuesByHierarchy, hasSelectionCriterion, hasValue, hasValue, isEmpty, isMissing, isOrphan, isSingular, setAspectModel, setAxis, setSelectionCriterion, setTransformer, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xbrlapi.aspects.Aspect

addFact, addValue, clearFacts, clearSelectionCriterion, getAncestorCount, getAspectModel, getAxis, getDescendantCount, getFacts, getFragment, getIterator, getKey, getMatchingFacts, getSelectionCriterion, getTransformer, getValue, getValues, getValuesByHierarchy, hasSelectionCriterion, hasValue, hasValue, isEmpty, isMissing, isOrphan, isSingular, setAspectModel, setAxis, setSelectionCriterion, setTransformer, size

Field Detail

TYPE

public static String TYPE

Constructor Detail

EntityIdentifierAspect

public EntityIdentifierAspect(AspectModel aspectModel)
                       throws XBRLException

Parameters:

aspectModel - The aspect model with this aspect.

Throws:

XBRLException.

XBRLException

Method Detail

getType

public String getType()

Specified by:

getType in interface Aspect

Returns:

the unique aspect identifier.

See Also:

Aspect.getType()

initialize

protected void initialize()

Overrides:

initialize in class ContextAspect

getValue

public EntityIdentifierAspectValue getValue(Fact fact)
                                     throws XBRLException

Specified by:

getValue in interface Aspect

Parameters:

fact - The fact to get the aspect value for

Returns:

the aspect value for the fact or the MissingAspectValue if the fact does not have a value for this aspect.

Throws:

XBRLException

See Also:

Aspect.getValue(org.xbrlapi.Fact)

getFragmentFromStore

public Entity getFragmentFromStore(Fact fact)
                            throws XBRLException

Specified by:

getFragmentFromStore in interface Aspect

Parameters:

fact - The fact to get the fragment from.

Returns:

the fragment, retrieved from the data store, that is required to generate an aspect value for the fact; or null if the fragment is not available.

Throws:

XBRLException

See Also:

Aspect.getFragmentFromStore(Fact)

hashCode

public int hashCode()

Overrides:

hashCode in class ContextAspect

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class ContextAspect

See Also:

Object.equals(java.lang.Object)