Package ch.pschatzmann.edgar.base

Class LabelAPI

java.lang.Object

ch.pschatzmann.edgar.base.LabelAPI

All Implemented Interfaces:

java.io.Serializable

public class LabelAPI
extends java.lang.Object
implements java.io.Serializable

Access to the label information

Author:

pschatzmann

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LabelAPI(XBRL xbrl)

Method Summary

Modifier and Type	Method	Description
void	close()
Label	getLabel(java.lang.String parameter)	Determines the default label
Label	getLabel(java.lang.String parameter, java.lang.String preferredRole)	Determines the label for the preferred role
java.util.Collection<Label>	getLabels(java.lang.String parameter)	Determines the Labels for the indicated parameter: Within a labelLink we find the loc with the help of the parameter name.
java.lang.String	getUOMLabel(java.lang.String unitRef)	Determines the UOM label

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LabelAPI

public LabelAPI(XBRL xbrl)

Method Detail

getLabels

public java.util.Collection<Label> getLabels(java.lang.String parameter)

Determines the Labels for the indicated parameter: Within a labelLink we find the loc with the help of the parameter name. From there we find the corresponding labelArc and then the related label

Parameters:

parameter -

Returns:

getLabel

public Label getLabel(java.lang.String parameter)

Determines the default label

Parameters:

parameter -

Returns:

getLabel

public Label getLabel(java.lang.String parameter,
                      java.lang.String preferredRole)

Determines the label for the preferred role

Parameters:

parameter -

preferredRole -

Returns:

getUOMLabel

public java.lang.String getUOMLabel(java.lang.String unitRef)

Determines the UOM label

Parameters:

unitRef -

Returns:

close

public void close()