org.xbrlapi.aspects
Class EntityAspect

java.lang.Object
  org.xbrlapi.aspects.AspectImpl
      org.xbrlapi.aspects.EntityAspect

All Implemented Interfaces:

Serializable, Aspect

public class EntityAspect
extends AspectImpl
implements Aspect

Entity aspect details

Entity aspects capture the entity identifier information in XBRL contexts. They do not capture entity segment information.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

static URI

ID The URI uniquely identifying this concept aspect.

Fields inherited from class org.xbrlapi.aspects.AspectImpl

domain

Constructor Summary

EntityAspect(Domain domain)

Method Summary

URI	getId()
EntityAspectValue	getMissingValue()
EntityAspectValue	getValue(Context context)
EntityAspectValue	getValue(Entity entity)
EntityAspectValue	getValue(Fact fact)

Methods inherited from class org.xbrlapi.aspects.AspectImpl

getDomain, getValue, isExtensible

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xbrlapi.aspects.Aspect

getDomain, getValue, isExtensible

Field Detail

ID

public static final URI ID

The URI uniquely identifying this concept aspect.

Constructor Detail

EntityAspect

public EntityAspect(Domain domain)
             throws XBRLException

Parameters:

domain - The domain for this aspect.

Throws:

XBRLException

Method Detail

getId

public URI getId()

Specified by:

getId in interface Aspect

Returns:

the URI that identifies this aspect.

See Also:

Aspect.getId()

getValue

public EntityAspectValue 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 EntityAspectValue getValue(Context context)
                           throws XBRLException

Specified by:

getValue in interface Aspect

Overrides:

getValue in class AspectImpl

Parameters:

context - The context to get the aspect value from.

Returns:

the aspect value for the context or the missing aspect value if the context does not define a value for the aspect.

Throws:

XBRLException

See Also:

Aspect.getValue(Context)

getValue

public EntityAspectValue getValue(Entity entity)
                           throws XBRLException

Parameters:

entity - The entity fragment to base the entity aspect value on.

Returns:

the entity aspect value reflecting the scheme and value expressed by the entity aspect.

Throws:

XBRLException - if the entity is null.

getMissingValue

public EntityAspectValue getMissingValue()

Specified by:

getMissingValue in interface Aspect

Returns:

the missing aspect value for this aspect.

See Also:

Aspect.getMissingValue()