com.ihr.xbrl.om.value

Interface IValueSpaceProvider

All Known Implementing Classes:

EBAProcessor

public interface IValueSpaceProvider

This interface contains methods implemented by processors that are able to restrict the value space of a fact to a list of values representable in a combo box or similar component in a user interface The initial idea is to reuse the component in the user interface for more than one processor.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
java.lang.String	getStringValueFromQNameValue(javax.xml.namespace.QName concept, javax.xml.namespace.QName qNameValue) Obtains the human readable value for a given QName value in the scope of a concept.
java.util.Iterator<DecorableValue<?>>	getValueSpace(javax.xml.namespace.QName concept) Returns an iterator over the value space of this concept definition or the empty iterator in case the concept does not contains a restricted value set on this processor.
boolean	isValueSpace(javax.xml.namespace.QName concept) Returns true if the concept definition identified by the QName contains a restricted value space and the processor implementing this interface is able to provide the restricted value set

Method Detail

isValueSpace

boolean isValueSpace(javax.xml.namespace.QName concept)

Returns true if the concept definition identified by the QName contains a restricted value space and the processor implementing this interface is able to provide the restricted value set

Parameters:

concept - the concept of an XBRLItem

Returns:

false if the QName is not a concept or if there is no restricted value set for this concept

getValueSpace

java.util.Iterator<DecorableValue<?>> getValueSpace(javax.xml.namespace.QName concept)

Returns an iterator over the value space of this concept definition or the empty iterator in case the concept does not contains a restricted value set on this processor.

Parameters:

concept - the concept of an XBRLItem

Returns:

an Iterator of the T type

getStringValueFromQNameValue

java.lang.String getStringValueFromQNameValue(javax.xml.namespace.QName concept,
                                              javax.xml.namespace.QName qNameValue)

Obtains the human readable value for a given QName value in the scope of a concept.

Parameters:

concept - the concept QName

qNameValue - the fact value for which the String shall be computed

Returns:

string value representation or the JClark QName representation as string if none exists