org.xbrlapi.aspects
Class ConceptAspect

java.lang.Object
  org.xbrlapi.aspects.BaseAspect
      org.xbrlapi.aspects.ConceptAspect

All Implemented Interfaces:

Serializable, Aspect

public class ConceptAspect
extends BaseAspect
implements Aspect

All facts have a value for the concept aspect.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Nested Class Summary

class

ConceptAspect.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

ConceptAspect(AspectModel aspectModel)

Method Summary

boolean	equals(Object obj)
Concept	getFragmentFromStore(Fact fact)
String	getKey(Fact fact) This basic implementation has a unique key for each fact This is not efficient from a memory footprint perspective and should be overridden where feasible.
String	getType()
ConceptAspectValue	getValue(Fact fact)
int	hashCode()
protected void	initialize()

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, 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

ConceptAspect

public ConceptAspect(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()

getValue

public ConceptAspectValue 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 Concept 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)

getKey

public String getKey(Fact fact)
              throws XBRLException

Description copied from class: BaseAspect

This basic implementation has a unique key for each fact This is not efficient from a memory footprint perspective and should be overridden where feasible.

Specified by:

getKey in interface Aspect

Overrides:

getKey in class BaseAspect

Parameters:

fact - The fact to get an aspect key for.

Returns:

the unique string identifying the fragment that is part of the aspect value for the given fact. This should be the empty string if the fact does not have a value for the aspect.

Throws:

XBRLException

See Also:

Aspect.getKey(Fact)

hashCode

public int hashCode()

Overrides:

hashCode in class BaseAspect

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class BaseAspect

See Also:

Object.equals(java.lang.Object)