com.ihr.xbrl.om.taxonomy
Class XBRLTuple

java.lang.Object
  extended by com.ihr.xbrl.om.XMLFragment
      extended by com.ihr.xbrl.om.taxonomy.XMLElementDefinition
          extended by com.ihr.xbrl.om.taxonomy.XBRLTuple
All Implemented Interfaces:
XBRLRelationshipPoint, XBRLValueKey, XMLHasParent, java.lang.Cloneable, javax.xml.namespace.NamespaceContext

public class XBRLTuple
extends XMLElementDefinition


Field Summary
static javax.xml.namespace.QName substitutionGroup
          This is xbrli:tuple
 
Fields inherited from class com.ihr.xbrl.om.taxonomy.XMLElementDefinition
abstract_, ALL, block, EMPTY, EXTENSION, final_, fixed, name, nillable, nullConcept, RESTRICTION, SUBSTITUTION, type, UNDEFINED
 
Fields inherited from class com.ihr.xbrl.om.XMLFragment
CONCEPT_LABEL, CONCEPT_QNAME, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, idQName, NO_POSITION, OrderComparator, PERIOD_TYPE, PERIOD_VALUE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER
 
Constructor Summary
XBRLTuple(XBRLTaxonomy tx, java.lang.String name, javax.xml.namespace.QName sg, java.lang.Boolean _abstract, java.lang.Boolean nillable, int block, int _final, XSDComposition comp)
          Creates a tuple definition in a taxonomy.
XBRLTuple(XBRLTaxonomy parent, net.sf.saxon.s9api.XdmNode node)
           
XBRLTuple(XMLElementDefinition other)
           
 
Method Summary
 void clear()
          Frees-up used memory This method should not be invoqued on live objects in the DTS.
 org.jdom.Element generateNode(boolean relativize, java.net.URI base)
          Serializes to a jdom Element the representation of the properties of this Information Item This method should be called from classes derived from this class
 XSDComposition getComposition()
          Access to the XSDComposition object.
 java.util.Iterator<XMLFragment> getElements()
          For complex type resources this returns an iterator with all children XML fragments Tthis method may be overwriten by other classes in the hierarchy
 java.lang.String getFriendlyName()
          Returns a string description that represents the element content in a form that users can understand.
 java.lang.String getFriendlyName(int modifiers, LabelsProvider lp)
          Returns a string description that represents the element content in a form that users can understand.
 java.util.Collection<XBRLTuple> getInSubstitutionGroup()
          Returns a collection of elements that are in the substitution group of this element or has this element in the substitution group hierarchy
 void setComposition(XSDComposition comp)
          Sets the composition to a new XSDComposition instance.
 XBRLValidationReport validate(XBRLCoreProcessor proc)
          Validates a tuple definition according to the XBRL 2.1 spec This method returns an XBRLValidationReport object with the errors detected or with no errors if none are detected.
 
Methods inherited from class com.ihr.xbrl.om.taxonomy.XMLElementDefinition
equals, generateLocatorToNode, getAbstract, getAttributes, getBlock, getBlock, getBlock, getChildren, getFinal, getFinal, getFinal, getFixed, getName, getNillable, getParent, getQName, getSimpleContentValidator, getSubstitutionGroup, getSubstitutionGroupHierarchy, getType, getValueKey, hashCode, isInSubstitutionGroup, setAbstract, setBlock, setFinal, setFixed, setId, setName, setNillable, setParent, setSubstitutionGroup, setType
 
Methods inherited from class com.ihr.xbrl.om.XMLFragment
addAttribute, addChild, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, clone, clone, delAttribute, delAttribute, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAttribute, getAttributeQNameValue, getAttributes, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getDeclaredNamespaces, getDocument, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getId, getLang, getNamespaceURI, getNodeName, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathNamespaceContext, getXPathToNode, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, isNamespaceDefined, objEquals, objHashCode, qNameToString, removeAttribute, removeChild, removeChild, removeFromRelationship, removeToRelationship, removeXMLChild, resetElements, resetHash, resolveHRef, resolveHRef, s_equal2, s_equal2, setAttributes, setBase, setDocument, setDocumentAndReload, setElements, setLang, setNamespaceContext, setNamespaces, setNode, setNodeName, setParent, setValue, setValue, setVariablesDefined, toString, valueEquals, xEqual
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ihr.xbrl.om.exLinks.XBRLRelationshipPoint
addFromRelationship, addToRelationship, getFromRelationships, getToRelationships, removeFromRelationship, removeToRelationship
 

Field Detail

substitutionGroup

public static final javax.xml.namespace.QName substitutionGroup
This is xbrli:tuple

Constructor Detail

XBRLTuple

public XBRLTuple(XBRLTaxonomy parent,
                 net.sf.saxon.s9api.XdmNode node)

XBRLTuple

public XBRLTuple(XMLElementDefinition other)

XBRLTuple

public XBRLTuple(XBRLTaxonomy tx,
                 java.lang.String name,
                 javax.xml.namespace.QName sg,
                 java.lang.Boolean _abstract,
                 java.lang.Boolean nillable,
                 int block,
                 int _final,
                 XSDComposition comp)
Creates a tuple definition in a taxonomy. Parameters are as follows:

Parameters:
tx - The parent taxonomy cannot be null.
name - tuple name
sg - substitution group
_abstract - boolean value
nillable - boolean value
block - int (see XMLElementDefinition)
_final - int (see XMLElementDefinition)
comp - XSDComposition object. This is the definition of the tuple content model.
Throws:
XBRLValidationException
Method Detail

clear

public void clear()
           throws java.lang.Throwable
Description copied from class: XMLFragment
Frees-up used memory

This method should not be invoqued on live objects in the DTS. It is automatically invoqued by the API when an object is no longer used and referenced by other objects. It is save not to call it directly.

Overrides:
clear in class XMLElementDefinition
Throws:
java.lang.Throwable

validate

public XBRLValidationReport validate(XBRLCoreProcessor proc)
Validates a tuple definition according to the XBRL 2.1 spec This method returns an XBRLValidationReport object with the errors detected or with no errors if none are detected. If the tuple data type cannot be retrieved the function raises a RuntimeException.

Returns:
XBRLValidationReport

generateNode

public org.jdom.Element generateNode(boolean relativize,
                                     java.net.URI base)
                              throws XBRLSerializationException
Description copied from class: XMLFragment
Serializes to a jdom Element the representation of the properties of this Information Item This method should be called from classes derived from this class

Overrides:
generateNode in class XMLElementDefinition
Parameters:
relativize - boolean indicating if URIs should be relativized to the base URI (see next argument)
base - the URI to which some attributes of this object should be relativided
Returns:
a clone of the surrounding jdom Element so it can be incorporated into multiple trees
Throws:
XBRLSerializationException

getComposition

public XSDComposition getComposition()
                              throws XBRLValidationException
Access to the XSDComposition object. This is a compiled representation of the content model.

Remarks: If the type definition is local to the tuple (complexType is child to the tuple element declaration), then the returned XSDComposition object will be used for generating back the XML representation of the tuple content model. If the type definition is global, the returned XSDComposition represents the tuple content model but it will not be used for generating the back the XML nodes.

Returns:
XSDComposition
Throws:
XBRLValidationException

setComposition

public void setComposition(XSDComposition comp)
Sets the composition to a new XSDComposition instance.

By calling this method the type property is reset as if XMLElementDefinition.setType(XBRLXSDTypeDefinition) were called with null parameter.

Parameters:
comp -
Since:
2.6.7

getElements

public java.util.Iterator<XMLFragment> getElements()
Description copied from class: XMLFragment
For complex type resources this returns an iterator with all children XML fragments Tthis method may be overwriten by other classes in the hierarchy

Overrides:
getElements in class XMLFragment
Returns:
Iterator

getInSubstitutionGroup

public java.util.Collection<XBRLTuple> getInSubstitutionGroup()
Description copied from class: XMLElementDefinition
Returns a collection of elements that are in the substitution group of this element or has this element in the substitution group hierarchy

Overrides:
getInSubstitutionGroup in class XMLElementDefinition
Returns:
Collection<XBRLTuple>

getFriendlyName

public java.lang.String getFriendlyName()
Description copied from class: XMLFragment
Returns a string description that represents the element content in a form that users can understand. This method may be overridden by parent classes.

Remarks, this method may return very long names not suitable for user interface

Overrides:
getFriendlyName in class XMLElementDefinition
Returns:
Non empty String. Internationalization is enabled

getFriendlyName

public java.lang.String getFriendlyName(int modifiers,
                                        LabelsProvider lp)
Description copied from class: XMLFragment
Returns a string description that represents the element content in a form that users can understand. This method may be override by parent classes.

This function accepts flags that are defined as constants in XMLFragment in order to modify the output.

Overrides:
getFriendlyName in class XMLElementDefinition
Parameters:
modifiers - integer
Returns:
Non empty String. Internationalization is enabled


Copyright 2006-2009 Reporting Standard S.L., C/ Torrecilla del Puerto 1, 28043, Madrid, Espaņa