org.xbrlapi.impl
Class AspectValueLabelImpl

java.lang.Object
  org.xbrlapi.impl.XMLImpl
      org.xbrlapi.impl.NonFragmentXMLImpl
          org.xbrlapi.impl.AspectValueLabelImpl

All Implemented Interfaces:

Serializable, 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

AspectValueLabelImpl()
No argument constructor.

AspectValueLabelImpl(Class<?> labellerClass, String id, URI aspectId, String valueId, String locale, URI resourceRole, URI linkRole, String label, boolean isFallbackLabel)

Method Summary

URI	getAspectId()
String	getLabel()
URI	getLinkRole()
String	getLocale()
URI	getResourceRole()
URI	getValueId()

Methods inherited from class org.xbrlapi.impl.NonFragmentXMLImpl

finalizeBuilder

Methods inherited from class org.xbrlapi.impl.XMLImpl

appendMetadataElement, compareTo, equals, finalize, 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

clone, 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(Class<?> labellerClass,
                            String id,
                            URI aspectId,
                            String valueId,
                            String locale,
                            URI resourceRole,
                            URI linkRole,
                            String label,
                            boolean isFallbackLabel)
                     throws XBRLException

Throws:

XBRLException

Method Detail

getAspectId

public URI getAspectId()
                throws XBRLException

Specified by:

getAspectId in interface AspectValueLabel

Returns:

the aspect ID

Throws:

XBRLException

See Also:

AspectValueLabel.getAspectId()

getLabel

public 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 URI 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 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 URI 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 URI getValueId()
               throws XBRLException

Specified by:

getValueId in interface AspectValueLabel

Returns:

the aspect value ID

Throws:

XBRLException

See Also:

AspectValueLabel.getValueId()