org.xbrlapi.xdt.aspects
Class DimensionAspect

java.lang.Object
  org.xbrlapi.aspects.BaseAspect
      org.xbrlapi.xdt.aspects.DimensionAspect

All Implemented Interfaces:

Serializable, Aspect

Direct Known Subclasses:

ExplicitDimensionAspect, TypedDimensionAspect

public abstract class DimensionAspect
extends BaseAspect
implements Aspect

Provides common functionality for XDT dimension aspects.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

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

DimensionAspect(AspectModel aspectModel, Dimension dimension)

Method Summary

boolean	equals(Object obj)
protected DimensionValueAccessor	getAccessor()
protected <D extends Dimension> D	getDimension()
URI	getLabelRole()
String	getLanguageCode()
String	getType()
int	hashCode()
protected void	initialize(Dimension dimension)
void	setLabelRole(URI role)
void	setLanguageCode(String language)

Methods inherited from class org.xbrlapi.aspects.BaseAspect

addFact, addValue, clearFacts, clearSelectionCriterion, getAncestorCount, getAspectModel, getAxis, getDescendantCount, getFacts, getFragment, getIterator, getKey, 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, getFragmentFromStore, getIterator, getKey, getMatchingFacts, getSelectionCriterion, getTransformer, getValue, getValue, getValues, getValuesByHierarchy, hasSelectionCriterion, hasValue, hasValue, isEmpty, isMissing, isOrphan, isSingular, setAspectModel, setAxis, setSelectionCriterion, setTransformer, size

Constructor Detail

DimensionAspect

public DimensionAspect(AspectModel aspectModel,
                       Dimension dimension)
                throws XBRLException

Parameters:

aspectModel - The aspect model with this aspect.

dimension - The dimension defining this aspect.

Throws:

XBRLException.

XBRLException

Method Detail

initialize

protected void initialize(Dimension dimension)
                   throws XBRLException

Throws:

XBRLException

getDimension

protected <D extends Dimension> D getDimension()

Returns:

the dimension defining this aspect.

getAccessor

protected DimensionValueAccessor getAccessor()

Returns:

the aspect value accessor.

getType

public String getType()
               throws XBRLException

Specified by:

getType in interface Aspect

Returns:

the unique aspect identifier.

Throws:

XBRLException - if the dimension does not have a namespace and local name.

See Also:

Aspect.getType()

getLabelRole

public URI getLabelRole()

Returns:

the label resource role.

setLabelRole

public void setLabelRole(URI role)

Parameters:

role - The label resource role to use in selecting labels for the concept.

getLanguageCode

public String getLanguageCode()

Returns:

the language code.

setLanguageCode

public void setLanguageCode(String language)
                     throws XBRLException

Parameters:

language - The ISO language code

Throws:

XBRLException

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)