org.xbrlapi.aspects
Class ConceptAspectValue

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

All Implemented Interfaces:

Serializable, AspectHandler, AspectValue

public class ConceptAspectValue
extends AspectValueImpl
implements AspectValue

See Also:

Serialized Form

Field Summary

protected static org.apache.log4j.Logger

logger

Constructor Summary

ConceptAspectValue()
Missing value constructor

ConceptAspectValue(URI namespace, String localname)

Method Summary

URI	getAspectId()
String	getId() This method must be implemented by each concrete aspect value class.
String	getLocalname()
URI	getNamespace()
boolean	isMissing() This method must be implemented by each concrete aspect value class.

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

ConceptAspectValue

public ConceptAspectValue()

Missing value constructor

ConceptAspectValue

public ConceptAspectValue(URI namespace,
                          String localname)
                   throws XBRLException

Parameters:

namespace - The namespace of the concept.

localname - 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()

Description copied from interface: AspectValue

This method must be implemented by each concrete aspect value class.

Specified by:

isMissing in interface AspectValue

Returns:

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

See Also:

AspectValue.isMissing()

getNamespace

public URI getNamespace()

Returns:

the namespace of the concept.

getLocalname

public String getLocalname()

Returns:

the local name of the concept.