org.xbrlapi.impl

Class AspectValueLabelImpl

java.lang.Object

org.xbrlapi.impl.XMLImpl

org.xbrlapi.impl.NonFragmentXMLImpl

org.xbrlapi.impl.AspectValueLabelImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<XML>, AspectValueLabel, NonFragmentXML, XML

public class AspectValueLabelImpl
extends NonFragmentXMLImpl
implements AspectValueLabel

An aspect value label XML resource stores information about a label for an aspect value.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AspectValueLabelImpl() No argument constructor.
AspectValueLabelImpl(java.lang.Class<?> labellerClass, java.lang.String id, java.lang.String aspectId, java.lang.String valueId, java.lang.String locale, java.lang.String resourceRole, java.lang.String linkRole, java.lang.String label, boolean isFallbackLabel)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAspectId()
java.lang.String	getLabel()
java.lang.String	getLinkRole()
java.lang.String	getLocale()
java.lang.String	getResourceRole()
java.lang.String	getValueId()

Methods inherited from class org.xbrlapi.impl.XMLImpl

appendMetadataElement, compareTo, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xbrlapi.XML

appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

AspectValueLabelImpl

public AspectValueLabelImpl()
                     throws XBRLException

No argument constructor.

Throws:

XBRLException

AspectValueLabelImpl

public AspectValueLabelImpl(java.lang.Class<?> labellerClass,
                    java.lang.String id,
                    java.lang.String aspectId,
                    java.lang.String valueId,
                    java.lang.String locale,
                    java.lang.String resourceRole,
                    java.lang.String linkRole,
                    java.lang.String label,
                    boolean isFallbackLabel)
                     throws XBRLException

Throws:

XBRLException

Method Detail

getAspectId

public java.lang.String getAspectId()
                             throws XBRLException

Specified by:

getAspectId in interface AspectValueLabel

Returns:

the aspect ID

Throws:

XBRLException

See Also:

AspectValueLabel.getAspectId()

getLabel

public java.lang.String getLabel()
                          throws XBRLException

Specified by:

getLabel in interface AspectValueLabel

Returns:

the label for the given aspect value

Throws:

XBRLException

See Also:

AspectValueLabel.getLabel()

getLinkRole

public java.lang.String getLinkRole()
                             throws XBRLException

Specified by:

getLinkRole in interface AspectValueLabel

Returns:

the extended link role or none if none is defined.

Throws:

XBRLException

See Also:

AspectValueLabel.getLinkRole()

getLocale

public java.lang.String getLocale()
                           throws XBRLException

Specified by:

getLocale in interface AspectValueLabel

Returns:

the locale (language) code or null if none is defined.

Throws:

XBRLException

See Also:

AspectValueLabel.getLocale()

getResourceRole

public java.lang.String getResourceRole()
                                 throws XBRLException

Specified by:

getResourceRole in interface AspectValueLabel

Returns:

the resource role or null if none is defined.

Throws:

XBRLException

See Also:

AspectValueLabel.getResourceRole()

getValueId

public java.lang.String getValueId()
                            throws XBRLException

Specified by:

getValueId in interface AspectValueLabel

Returns:

the aspect value ID

Throws:

XBRLException

See Also:

AspectValueLabel.getValueId()