org.xbrlapi.aspects
Class EntityAspectValue

java.lang.Object
  org.xbrlapi.aspects.AspectValueImpl
      org.xbrlapi.aspects.EntityAspectValue

All Implemented Interfaces:

Serializable, AspectHandler, AspectValue

public class EntityAspectValue
extends AspectValueImpl
implements AspectValue

See Also:

Serialized Form

Field Summary

protected static org.apache.log4j.Logger

logger

Constructor Summary

EntityAspectValue()
Missing aspect value constructor - relevant for tuples and nil facts.

EntityAspectValue(URI scheme, String value)

Method Summary

URI	getAspectId()
String	getId() This method must be implemented by each concrete aspect value class.
URI	getScheme()
String	getValue()
boolean	isMissing() There is no such thing as a missing concept aspect value.

Methods inherited from class org.xbrlapi.aspects.AspectValueImpl

equals, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Constructor Detail

EntityAspectValue

public EntityAspectValue()

Missing aspect value constructor - relevant for tuples and nil facts.

EntityAspectValue

public EntityAspectValue(URI scheme,
                         String value)
                  throws XBRLException

Parameters:

scheme - The namespace of the concept.

value - The local name of the concept.

Throws:

XBRLException - if either of the parameters is null.

Method Detail

getId

public String getId()

Description copied from interface: AspectValue

This method must be implemented by each concrete aspect value class. The identifier associated with a "missing-value" aspect value is implementation dependent. You cannot assume that it will be the empty string or a null value.

Specified by:

getId in interface AspectValue

Returns:

the string value that uniquely identifies this aspect value, for a given aspect. This value is not generally human readable. The label handler methods are more suitable for obtaining human readable representations of aspect values. A unique value for missing aspect values needs to be generated by implementations of this method.

See Also:

AspectValue.getId()

getAspectId

public URI getAspectId()

Specified by:

getAspectId in interface AspectHandler

Returns:

the aspect itself

See Also:

AspectHandler.getAspectId()

isMissing

public boolean isMissing()

There is no such thing as a missing concept aspect value. All facts are facts specifying a value for a concept.

Specified by:

isMissing in interface AspectValue

Returns:

true if this aspect value represents a missing value and false otherwise.

See Also:

AspectValue.isMissing()

getScheme

public URI getScheme()

Returns:

the entity identification scheme or null for missing values.

getValue

public String getValue()

Returns:

the entity identification value or null for missing values.