|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.ihr.xbrl.om.XMLFragment
com.ihr.xbrl.om.taxonomy.XMLElementDefinition
com.ihr.xbrl.om.taxonomy.XBRLTuple
public class XBRLTuple
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation |
|---|
XBRLValidation.Direction |
| 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 |
XBRLValidationReport |
getValidationReport()
Access to the last stored validation report |
void |
invalidate()
Invalidates the XBRLFact for XBRL validation. |
boolean |
invalidate(XBRLValidation.Direction dir)
Invalidates this object and the elements in the XML tree according with the parameter in dir This method is used by GUI tools that requires to reset validation before a manual validation cycle is started |
boolean |
isOnValidation()
When validation is a recursive process, this function returns true if the object going to be validated is already under validation. |
void |
setComposition(XSDComposition comp)
Sets the composition to a new XSDComposition instance. |
XBRLValidationReport |
validate(XBRLPlugInProcessor proc)
Executes validation on the instance object and returns a validation report. |
| Methods inherited from class com.ihr.xbrl.om.taxonomy.XMLElementDefinition |
|---|
equals, generateLocatorToNode, getAbstract, getAttributes, getBlock, getBlock, getBlock, getChildren, getContentValidator, getFinal, getFinal, getFinal, getFixed, getName, getNillable, getParent, getQName, getSimpleContentValidator, getSubstitutionGroup, getSubstitutionGroupHierarchy, getType, getValueKey, hashCode, isAbstract, isInSubstitutionGroup, setAbstract, setBlock, setFinal, setFixed, setId, setName, setNillable, setParent, setSubstitutionGroup, setType |
| 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 |
|---|
public static final javax.xml.namespace.QName substitutionGroup
| Constructor Detail |
|---|
public XBRLTuple(XBRLTaxonomy parent,
net.sf.saxon.s9api.XdmNode node)
public XBRLTuple(XMLElementDefinition other)
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)
tx - The parent taxonomy cannot be null.name - tuple namesg - substitution group_abstract - boolean valuenillable - boolean valueblock - int (see XMLElementDefinition)_final - int (see XMLElementDefinition)comp - XSDComposition object. This is the definition of the tuple content model.
XBRLValidationException| Method Detail |
|---|
public void clear()
throws java.lang.Throwable
XMLFragmentThis 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.
clear in class XMLElementDefinitionjava.lang.Throwable
public org.jdom.Element generateNode(boolean relativize,
java.net.URI base)
throws XBRLSerializationException
XMLFragment
generateNode in class XMLElementDefinitionrelativize - 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
XBRLSerializationException
public XSDComposition getComposition()
throws XBRLValidationException
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.
XBRLValidationExceptionpublic void setComposition(XSDComposition comp)
By calling this method the type
property is reset as if XMLElementDefinition.setType(XBRLXSDTypeDefinition) were called with null
parameter.
comp - public java.util.Iterator<XMLFragment> getElements()
XMLFragment
getElements in class XMLFragmentpublic java.util.Collection<XBRLTuple> getInSubstitutionGroup()
XMLElementDefinition
getInSubstitutionGroup in class XMLElementDefinitionpublic java.lang.String getFriendlyName()
XMLFragmentRemarks, this method may return very long names not suitable for user interface
getFriendlyName in class XMLElementDefinition
public java.lang.String getFriendlyName(int modifiers,
LabelsProvider lp)
XMLFragmentThis function accepts flags that are defined as constants in XMLFragment in order to modify the output.
getFriendlyName in class XMLElementDefinitionmodifiers - integer
public XBRLValidationReport getValidationReport()
XBRLValidation
getValidationReport in interface XBRLValidationpublic XBRLValidationReport validate(XBRLPlugInProcessor proc)
XBRLValidation
The validation result may be cached internally. A call to XBRLValidation.invalidate(Direction) clears the validation cache.
validate in interface XBRLValidationproc - the processor under which the object is going to be validated. Note the same object can be validated on multiple processors.
public void invalidate()
XBRLValidation
invalidate in interface XBRLValidationpublic boolean invalidate(XBRLValidation.Direction dir)
XBRLValidationThis method is used by GUI tools that requires to reset validation before a manual validation cycle is started
invalidate in interface XBRLValidationdir - see the XBRLValidation.Direction enumeration for more information.public boolean isOnValidation()
XBRLValidation
isOnValidation in interface XBRLValidation
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||