org.xbrlapi.aspects

Class ConceptAspect

java.lang.Object

org.xbrlapi.aspects.AspectImpl

org.xbrlapi.aspects.ConceptAspect

All Implemented Interfaces:

java.io.Serializable, Aspect

public class ConceptAspect
extends AspectImpl
implements Aspect

Concept aspect details

All facts have a value for the concept aspect. The concept aspect reflects the element that is used to express fact values. Ideally, this would also be able to reflect substitution group and/or XLink relationships between concepts. Perhaps such complexities are best left to more sophisticated variants of the concept aspect. What you want is to be able to filter facts based upon the concepts at the top of a heirarchy and to get all facts that have a concept aspect value that is within the aspect value subtree specified by that higher-level concept.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID The URI uniquely identifying this concept aspect.

Constructor Summary

Constructors

Constructor and Description
ConceptAspect(Domain domain)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getId()
ConceptAspectValue	getMissingValue()
ConceptAspectValue	getValue(Concept concept)
ConceptAspectValue	getValue(Fact fact)

Methods inherited from class org.xbrlapi.aspects.AspectImpl

getDomain, getValue, getValue, isExtensible

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xbrlapi.aspects.Aspect

getDomain, getValue, getValue, isExtensible

Field Detail

ID

public static final java.lang.String ID

The URI uniquely identifying this concept aspect.

See Also:

Constant Field Values

Constructor Detail

ConceptAspect

public ConceptAspect(Domain domain)
              throws XBRLException

Parameters:

domain - The domain for this aspect.

Throws:

XBRLException

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface Aspect

Returns:

the URI that identifies this aspect.

See Also:

Aspect.getId()

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:

a value for this aspect for the given fact.

Throws:

XBRLException

See Also:

Aspect.getValue(Fact)

getValue

public ConceptAspectValue getValue(Concept concept)
                            throws XBRLException

Parameters:

concept - The concept to get the concept aspect value for.

Returns:

the concept aspect value for this concept.

Throws:

XBRLException

getMissingValue

public ConceptAspectValue getMissingValue()

Specified by:

getMissingValue in interface Aspect

Returns:

the missing aspect value for this aspect.

See Also:

Aspect.getMissingValue()