XMLElementDefinition

java.lang.Object
- net.sf.saxon.tree.linked.NodeImpl
- - net.sf.saxon.tree.linked.ElementImpl
  - - com.ihr.xbrl.om.XMLFragment
    - - com.ihr.xbrl.om.taxonomy.XMLElementDefinition

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, XBRLValueKey, java.io.Serializable, java.lang.Cloneable, javax.xml.namespace.NamespaceContext, javax.xml.transform.Source, javax.xml.transform.SourceLocator, net.sf.saxon.evpull.PullEvent, net.sf.saxon.om.FingerprintedNode, net.sf.saxon.om.Item, net.sf.saxon.om.MutableNodeInfo, net.sf.saxon.om.NamespaceResolver, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>, net.sf.saxon.tree.wrapper.SiblingCountingNode

Direct Known Subclasses:

XBRLElementDefinition
```
public class XMLElementDefinition
extends XMLFragment
implements XBRLValueKey
```
Common elements to both Tuples and Items.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.ihr.xbrl.om.XMLFragment
  XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>

Field Summary

Fields
Modifier and Type	Field and Description
`static javax.xml.namespace.QName`	`abstract_` The [Abstract] property.
`static int`	`ALL` The Constant ALL.
`static javax.xml.namespace.QName`	`block` The [Block] property.
`static javax.xml.namespace.QName`	`elementDocNode` The element doc node.
`static int`	`EMPTY` The Constant EMPTY.
`static int`	`EXTENSION` The Constant EXTENSION.
`static javax.xml.namespace.QName`	`final_` The [Final] property.
`static javax.xml.namespace.QName`	`fixed` The [Fixed] property.
`static javax.xml.namespace.QName`	`name` The [Name] property.
`static javax.xml.namespace.QName`	`nillable` The [Nillable] property.
`static XMLElementDefinition`	`nullConcept` The Constant nullConcept.
`static int`	`RESTRICTION` The Constant RESTRICTION.
`static int`	`SUBSTITUTION` The Constant SUBSTITUTION.
`static javax.xml.namespace.QName`	`substitutionGroup` The [Substitution Group] property.
`static javax.xml.namespace.QName`	`type` The [Type] property. can be null if this element is in the substitution group of another element that has a type
`static int`	`UNDEFINED` The Constant UNDEFINED.

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl
NODE_LETTER

Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors
Constructor and Description
`XMLElementDefinition(DTSContainer dts)` Constructor used when Element Declarations are created while parsing XML.
`XMLElementDefinition(XBRLTaxonomy parent, java.lang.String name, XBRLXSDTypeDefinition type, javax.xml.namespace.QName substitutionGroup, java.lang.Boolean _abstract, java.lang.Boolean nillable, int block, int _final, java.lang.String fixed)` Constructor to programatically create an element definition.
`XMLElementDefinition(XBRLTaxonomy parent, XMLFragment node)` Constructor used when the concept comes from a NodeInfo.
`XMLElementDefinition(XMLFragment node)` Constructor used when the concept comes from a NodeInfo.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear.
`boolean`	`equals(java.lang.Object other)` Equals.
`XMLElementDefinition`	`generateNode()` Generate node.
`boolean`	`getAbstract()` Deprecated.
`java.util.Iterator<XBRLAttribute>`	`getAttributes()` Access to the [Attributes] property.
`int`	`getBlock()` Access to the [Block] property.
`static java.lang.String`	`getBlock(int block)` Returns a string representation of the value of the block attribute suitable to be used as the value of the block attribute in an element definition in a schema.
`static int`	`getBlock(java.lang.String str)` Converts the string representation of Block to a integer codification.
`java.util.Iterator<XMLFragment>`	`getChildrenType()` Access to the [children] property.
`com.saxonica.ee.validate.ContentValidator`	`getContentValidator()` Returns a ContentValidator instance that is able to validate the element content.
`int`	`getFinal()` Access to the [Final] property.
`static java.lang.String`	`getFinal(int _final)` Returns a string representation of the value of the block attribute suitable to be used as the value of the block attribute in an element definition in a schema.
`static int`	`getFinal(java.lang.String str)` Converts the string representation of the final token into a code.
`net.sf.saxon.tree.linked.NodeImpl`	`getFirstChild()`
`java.lang.String`	`getFixed()` Access to the [Fixed] property.
`java.lang.String`	`getFriendlyName()` Gets the friendly name.
`java.lang.String`	`getFriendlyName(int modifiers, LabelsProvider lp)` Gets the friendly name.
`java.util.Collection<? extends XMLElementDefinition>`	`getInSubstitutionGroup()` Returns a collection of elements that are in the substitution group of this element or has this element in the substitution group hierarchy.
`net.sf.saxon.tree.linked.NodeImpl`	`getLastChild()`
`java.lang.String`	`getName()` Access to the [Name] property.
`boolean`	`getNillable()` Return the value of the [nillable] property.
`int`	`getNumberOfChildren()`
`XBRLTaxonomy`	`getParentDocument()` Access to the [Parent] property.
`javax.xml.namespace.QName`	`getQName()` Access to the QName property (Not in the infoset) The QName property is a QName with taxonomy targetNamespace and local name equal to the element declaration name There is no setQName method in this object.
`com.saxonica.ee.validate.SimpleContentValidator`	`getSimpleContentValidator()` Deprecated.
`javax.xml.namespace.QName`	`getSubstitutionGroup()` Acces to the [Substitution Group] property.
`java.util.Collection<XMLElementDefinition>`	`getSubstitutionGroupHierarchy()` Returns a collection of XMLElementDefinition elements representing the substitution group hierarchy tree for this concept definition.
`XBRLXSDTypeDefinition`	`getType()` Access to the [Type] property Returns null if the element has no type definition or if the type is locally defined The returned object is a wrapper of the XSD type definition.
`net.sf.saxon.value.QNameValue`	`getValueKey()` Gets the value key.
`boolean`	`hasChildNodes()`
`int`	`hashCode()` Hash code.
`boolean`	`isAbstract()` Return the value of the [Abstract] property.
`boolean`	`isInSubstitutionGroup(XMLElementDefinition element)` Returns true if the element received as a parameter is in this element's substitution group.
`boolean`	`isTotal(XBRLRoleType role)` Returns true if the role passed in is defined as a total role.
`java.lang.Boolean`	`setAbstract(java.lang.Boolean abstract_)` Sets the value of the [Abstract] property.
`java.lang.Integer`	`setBlock(java.lang.Integer newValue)` Sets the value of the [Block] property or resets it if newValue is null.
`void`	`setElementDeclaration(com.saxonica.ee.schema.ElementDecl sc)` Sets the element declaration.
`java.lang.Integer`	`setFinal(java.lang.Integer newValue)` Set the value of the [Final] property or resets it if newValue is null.
`java.lang.String`	`setFixed(java.lang.String value)` Sets the value of the [Fixed] property.
`void`	`setId(java.lang.String id)` Sets the ID for the concept definition.
`java.lang.String`	`setName(java.lang.String newName)` Sets the [Name] property to the value indicated.
`java.lang.Boolean`	`setNillable(java.lang.Boolean nillable)` Sets the value of the [Nillable] property.
`javax.xml.namespace.QName`	`setSubstitutionGroup(javax.xml.namespace.QName substitutionGroup)` Sets or reset the value of the [substitutionGroup] property
`XBRLXSDTypeDefinition`	`setType(XBRLXSDTypeDefinition type)` Sets the item type to the type specified in the XBRLXSDTypeDefinition object or unset the type definition if the attribute value is null.

Methods inherited from class com.ihr.xbrl.om.XMLFragment
addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addChild, addChildArray, addChildAt, addChildNode, addChildNodeArray, addChildNodeAt, addChildNodeInBatch, addComment, addFromRelationship, addNamespace, addNamespace, addPropertyChangeListener, addToRelationship, changeBase, checkBase, childExists, clone, clone, commitBatch, copy, createComment, delAttribute, delAttribute, delete, equalXdmValues, findFirstNodeOfClass, findPosition, firePropertyChangeEvent, generateId, generateLocatorToNode, generatePrefix, getAllAttributes, getAttribute, getAttributeAtomicValue, getAttributeBooleanValue, getAttributeGroundedValue, getAttributeQNameValue, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getContainerDocumentURI, getDocument, getElement, getElement, getElements, getFirstChildNoComment, getFragment, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentXBRL, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isHashDependsOnAtribute, isNamespaceDefined, isNil, moveNamespacesUp, objEquals, objHashCode, reindex, removeChild, removeChildNode, removeFromRelationship, removeNamespace, removePropertyChangeListener, removeToRelationship, replace, replaceChild, replaceStringValue, resetElements, resolveHRef, s_equal2_xp2, s_equal2_xp2, s_equal2, s_equal2, s_equal2, s_equal2, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setRawParentXBRL, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, valueEquals, xEqual

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl
addAttribute, addNamespace, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, isId, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, setLocation, setNameCode, setNamespaceList, setSystemId, setTypeAnnotation

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl
atomize, compareOrder, comparePosition, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getSuccessorElement, getURI, head, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterate, iterateAxis, iterateAxis, newBuilder, replace

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - elementDocNode
```
public static final javax.xml.namespace.QName elementDocNode
```
    The element doc node.
  - name
```
public static final javax.xml.namespace.QName name
```
    The [Name] property.
  - type
```
public static final javax.xml.namespace.QName type
```
    The [Type] property. can be null if this element is in the substitution group of another element that has a type
  - substitutionGroup
```
public static final javax.xml.namespace.QName substitutionGroup
```
    The [Substitution Group] property.
  - nillable
```
public static final javax.xml.namespace.QName nillable
```
    The [Nillable] property.
  - abstract_
```
public static final javax.xml.namespace.QName abstract_
```
    The [Abstract] property.
  - UNDEFINED
```
public static final int UNDEFINED
```
    The Constant UNDEFINED.
    
    See Also:
    
    Constant Field Values
  - EMPTY
```
public static final int EMPTY
```
    The Constant EMPTY.
    
    See Also:
    
    Constant Field Values
  - ALL
```
public static final int ALL
```
    The Constant ALL.
    
    See Also:
    
    Constant Field Values
  - EXTENSION
```
public static final int EXTENSION
```
    The Constant EXTENSION.
    
    See Also:
    
    Constant Field Values
  - RESTRICTION
```
public static final int RESTRICTION
```
    The Constant RESTRICTION.
    
    See Also:
    
    Constant Field Values
  - SUBSTITUTION
```
public static final int SUBSTITUTION
```
    The Constant SUBSTITUTION.
    
    See Also:
    
    Constant Field Values
  - block
```
public static final javax.xml.namespace.QName block
```
    The [Block] property.
  - fixed
```
public static final javax.xml.namespace.QName fixed
```
    The [Fixed] property.
  - final_
```
public static final javax.xml.namespace.QName final_
```
    The [Final] property.
  - nullConcept
```
public static final XMLElementDefinition nullConcept
```
    The Constant nullConcept.
- Constructor Detail
  - XMLElementDefinition
```
public XMLElementDefinition(XMLFragment node)
```
    Constructor used when the concept comes from a NodeInfo.
    
    Parameters:
    
    node - the node info with the element definition
  - XMLElementDefinition
```
public XMLElementDefinition(XBRLTaxonomy parent,
                            XMLFragment node)
```
    Constructor used when the concept comes from a NodeInfo.
    
    Parameters:
    
    parent - Parent taxonomy
    
    node - the node info with the element definition
  - XMLElementDefinition
```
public XMLElementDefinition(XBRLTaxonomy parent,
                            java.lang.String name,
                            XBRLXSDTypeDefinition type,
                            javax.xml.namespace.QName substitutionGroup,
                            java.lang.Boolean _abstract,
                            java.lang.Boolean nillable,
                            int block,
                            int _final,
                            java.lang.String fixed)
```
    Constructor to programatically create an element definition.
    
    Parameters:
    
    parent - the parent taxonomy (schema)
    
    name - String the new element name, cannot be null
    
    type - XBRLXSDTypeDefinition the type definition for this new element, may be null
    
    substitutionGroup - QName the substitution group, may also be null
    
    _abstract - Boolean true if the element definition is abstract
    
    nillable - Boolean true if the xsi:nill is permitted null here means nillable is false.
    
    block - int indicating the block value (see XSD Infoset) {UNDEFINED | EMPTY | ALL | EXTENSION | RESTRICTION | SUBSTITUTION}
    
    _final - int indicating final for (see XSD Infoset) {UNDEFINED | EMPTY | ALL | EXTENSION | RESTRICTION | SUBSTITUTION}
    
    fixed - String fixed value, can be null
  - XMLElementDefinition
```
public XMLElementDefinition(DTSContainer dts)
```
    Constructor used when Element Declarations are created while parsing XML.
    
    Parameters:
    
    dts - the dts
- Method Detail
  - setElementDeclaration
```
public void setElementDeclaration(com.saxonica.ee.schema.ElementDecl sc)
```
    Sets the element declaration.
    
    Parameters:
    
    sc - the new element declaration
  - setType
```
public XBRLXSDTypeDefinition setType(XBRLXSDTypeDefinition type)
```
    Sets the item type to the type specified in the XBRLXSDTypeDefinition object or unset the type definition if the attribute value is null.
    
    Parameters:
    
    type - new XBRLXSDTypeDefinition or null
    
    Returns:
    
    old type definition XBRLXSDTypeDefinition
    
    Since:
    
    2.6.5
  - clear
```
public void clear()
           throws java.lang.Throwable
```
    Clear.
    
    Overrides:
    
    clear in class XMLFragment
    
    Throws:
    
    java.lang.Throwable - the throwable
  - getQName
```
public javax.xml.namespace.QName getQName()
```
    Access to the QName property (Not in the infoset)
    The QName property is a QName with taxonomy targetNamespace and local name equal to the element declaration name
    There is no setQName method in this object. Use setName and/or setParent instead
    
    Returns:
    
    QName
  - getParentDocument
```
public XBRLTaxonomy getParentDocument()
```
    Access to the [Parent] property.
    
    Overrides:
    
    getParentDocument in class XMLFragment
    
    Returns:
    
    the XBRLTaxonomy where the element is defined
  - getName
```
public java.lang.String getName()
```
    Access to the [Name] property.
    
    Returns:
    
    String
  - setName
```
public java.lang.String setName(java.lang.String newName)
```
    Sets the [Name] property to the value indicated.
    
    Parameters:
    
    newName - as string or null to reset the name
    
    Returns:
    
    the old value of the name attribute
    
    Since:
    
    2.6.5
  - getType
```
public XBRLXSDTypeDefinition getType()
```
    Access to the [Type] property Returns null if the element has no type definition or if the type is locally defined The returned object is a wrapper of the XSD type definition.
    
    Returns:
    
    XBRLXSDTypeDefinition
  - getContentValidator
```
public com.saxonica.ee.validate.ContentValidator getContentValidator()
```
    Returns a ContentValidator instance that is able to validate the element content. Modified in version 2.7.7 the return parameter is not a ContentValidator (superclass of the SimpleContentValidator) and now the possible return values includes AnyTypeValidator when the type is AnyType
    
    Returns:
    
    ContentValidator
    
    Since:
    
    2.7.7
  - getSimpleContentValidator
```
@Deprecated
public com.saxonica.ee.validate.SimpleContentValidator getSimpleContentValidator()
```
    Deprecated.
    
    Returns a SimpleContentValidator instance that is able to validate the element content. This method is depredated. Use getContentValidator() instead
    
    Returns:
    
    SimpleContentValidator
    
    Since:
    
    2.6.7
    
    See Also:
    
    getContentValidator()
  - setId
```
public void setId(java.lang.String id)
           throws XBRLInconsistentDTSException
```
    Sets the ID for the concept definition. Updates the taxonomy accordingly
    
    Overrides:
    
    setId in class XMLFragment
    
    Parameters:
    
    id - the new id
    
    Throws:
    
    XBRLInconsistentDTSException - the XBRL inconsistent dts exception
  - getSubstitutionGroup
```
public javax.xml.namespace.QName getSubstitutionGroup()
```
    Acces to the [Substitution Group] property.
    
    Returns:
    
    QName
  - setSubstitutionGroup
```
public javax.xml.namespace.QName setSubstitutionGroup(javax.xml.namespace.QName substitutionGroup)
```
    Sets or reset the value of the [substitutionGroup] property
    
    Parameters:
    
    substitutionGroup - QName to set, null to reset
    
    Returns:
    
    the previous value of the [substitutionGroup] property
    
    Since:
    
    2.6.5
  - getNillable
```
public boolean getNillable()
```
    Return the value of the [nillable] property. If this element can be reported with xsi:nil="true" then this method returns true.
    
    Returns:
    
    boolean
    
    See Also:
    
    XMLFragment.isNil()
  - setNillable
```
public java.lang.Boolean setNillable(java.lang.Boolean nillable)
```
    Sets the value of the [Nillable] property. Use null to reset the value
    
    Parameters:
    
    nillable - the nillable
    
    Returns:
    
    old value
    
    Since:
    
    2.6.5
  - getAbstract
```
@Deprecated
public boolean getAbstract()
```
    Deprecated.
    
    Return the value of the [Abstract] property.
    Deprecated. Use isAbstract() instead.
    
    Returns:
    
    boolean
  - isAbstract
```
public boolean isAbstract()
```
    Return the value of the [Abstract] property.
    
    Returns:
    
    boolean
  - setAbstract
```
public java.lang.Boolean setAbstract(java.lang.Boolean abstract_)
```
    Sets the value of the [Abstract] property. Use null to reset the value
    
    Parameters:
    
    abstract_ - the abstract_
    
    Returns:
    
    old value
    
    Since:
    
    2.6.5
  - getFixed
```
public java.lang.String getFixed()
```
    Access to the [Fixed] property.
    
    Returns:
    
    String
  - setFixed
```
public java.lang.String setFixed(java.lang.String value)
```
    Sets the value of the [Fixed] property.
    
    Parameters:
    
    value - new value or null to reset
    
    Returns:
    
    old value
    
    Since:
    
    2.6.5
  - getFinal
```
public int getFinal()
```
    Access to the [Final] property.
    
    Returns:
    
    int
  - setFinal
```
public java.lang.Integer setFinal(java.lang.Integer newValue)
```
    Set the value of the [Final] property or resets it if newValue is null.
    
    Parameters:
    
    newValue - the new value of the final attribute. See constants defined in this object
    
    Returns:
    
    Integer constant with old value or null if previous value was not set
    
    Since:
    
    2.6.5
  - getFinal
```
public static int getFinal(java.lang.String str)
```
    Converts the string representation of the final token into a code. If the string does not corresponds to "#all" "extension" or "restriction" the method returns EMPTY
    
    Parameters:
    
    str - the str
    
    Returns:
    
    Integer
  - getFinal
```
public static java.lang.String getFinal(int _final)
```
    Returns a string representation of the value of the block attribute suitable to be used as the value of the block attribute in an element definition in a schema. If the value is not defined thorws an XBRLRuntimeException If the value is UNDEFINED | EMPTY the function returns null
    
    Parameters:
    
    _final - int
    
    Returns:
    
    String
  - getBlock
```
public int getBlock()
```
    Access to the [Block] property.
    
    Returns:
    
    int
  - setBlock
```
public java.lang.Integer setBlock(java.lang.Integer newValue)
```
    Sets the value of the [Block] property or resets it if newValue is null.
    
    Parameters:
    
    newValue - Integer constant or null to reset
    
    Returns:
    
    oldValue or null if previous value was not set
    
    Since:
    
    2.6.5
  - getBlock
```
public static int getBlock(java.lang.String str)
```
    Converts the string representation of Block to a integer codification.
    
    Parameters:
    
    str - any of "#all" "extension" "restriction" "substitution"
    
    Returns:
    
    the code corresponding to the string, if the string is none of those this method returns the code for EMPTY
  - getBlock
```
public static java.lang.String getBlock(int block)
```
    Returns a string representation of the value of the block attribute suitable to be used as the value of the block attribute in an element definition in a schema. If the value is not defined thorws an XBRLRuntimeException If the value is UNDEFINED | EMPTY the function returns null
    
    Parameters:
    
    block - integer
    
    Returns:
    
    String
  - getAttributes
```
public java.util.Iterator<XBRLAttribute> getAttributes()
```
    Access to the [Attributes] property.
    
    Overrides:
    
    getAttributes in class XMLFragment
    
    Returns:
    
    Iterator
    
    See Also:
    
    XMLFragment.getAllAttributes()
  - getChildrenType
```
public java.util.Iterator<XMLFragment> getChildrenType()
```
    Access to the [children] property.
    
    Returns:
    
    Iterator
  - generateNode
```
public XMLElementDefinition generateNode()
                                  throws XBRLSerializationException
```
    Generate node.
    
    Overrides:
    
    generateNode in class XMLFragment
    
    Returns:
    
    the XML element definition
    
    Throws:
    
    XBRLSerializationException - the XBRL serialization exception
  - hashCode
```
public int hashCode()
```
    Hash code.
    
    Specified by:
    
    hashCode in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    hashCode in class XMLFragment
    
    Returns:
    
    the int
  - equals
```
public boolean equals(java.lang.Object other)
```
    Equals.
    
    Specified by:
    
    equals in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    equals in class XMLFragment
    
    Parameters:
    
    other - the other
    
    Returns:
    
    true, if successful
  - getValueKey
```
public net.sf.saxon.value.QNameValue getValueKey()
```
    Gets the value key.
    
    Specified by:
    
    getValueKey in interface XBRLValueKey
    
    Returns:
    
    the value key
  - getInSubstitutionGroup
```
public java.util.Collection<? extends XMLElementDefinition> getInSubstitutionGroup()
```
    Returns a collection of elements that are in the substitution group of this element or has this element in the substitution group hierarchy.
    
    Returns:
    
    Collection<? extends XMLElementDefinition>
  - getSubstitutionGroupHierarchy
```
public java.util.Collection<XMLElementDefinition> getSubstitutionGroupHierarchy()
```
    Returns a collection of XMLElementDefinition elements representing the substitution group hierarchy tree for this concept definition.
    
    Returns:
    
    Collection<XMLElementDefinition>
    
    Since:
    
    2.7
  - isInSubstitutionGroup
```
public boolean isInSubstitutionGroup(XMLElementDefinition element)
```
    Returns true if the element received as a parameter is in this element's substitution group. This means, the parameter element can substitute this element
    
    Parameters:
    
    element - the element
    
    Returns:
    
    boolean
  - getFriendlyName
```
public java.lang.String getFriendlyName()
```
    Gets the friendly name.
    
    Overrides:
    
    getFriendlyName in class XMLFragment
    
    Returns:
    
    the friendly name
  - getFriendlyName
```
public java.lang.String getFriendlyName(int modifiers,
                                        LabelsProvider lp)
```
    Gets the friendly name.
    
    Overrides:
    
    getFriendlyName in class XMLFragment
    
    Parameters:
    
    modifiers - the modifiers
    
    lp - the lp
    
    Returns:
    
    the friendly name
  - isTotal
```
public boolean isTotal(XBRLRoleType role)
```
    Returns true if the role passed in is defined as a total role.
    
    Parameters:
    
    role - the role the calculation arc will be search on. if null, the relationship will be scanned on any role in the DTS
    
    Returns:
    
    boolean value to guess this item is a total
    
    Since:
    
    2.8.3
  - hasChildNodes
```
public final boolean hasChildNodes()
```
    Specified by:
    
    hasChildNodes in interface net.sf.saxon.om.NodeInfo
    
    Overrides:
    
    hasChildNodes in class net.sf.saxon.tree.linked.NodeImpl
  - getNumberOfChildren
```
public final int getNumberOfChildren()
```
  - getFirstChild
```
public final net.sf.saxon.tree.linked.NodeImpl getFirstChild()
```
    Specified by:
    
    getFirstChild in interface net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>
    
    Overrides:
    
    getFirstChild in class net.sf.saxon.tree.linked.NodeImpl
  - getLastChild
```
public final net.sf.saxon.tree.linked.NodeImpl getLastChild()
```
    Overrides:
    
    getLastChild in class net.sf.saxon.tree.linked.NodeImpl

Class XMLElementDefinition

Nested Class Summary

Nested classes/interfaces inherited from class com.ihr.xbrl.om.XMLFragment

Field Summary

Fields inherited from class com.ihr.xbrl.om.XMLFragment

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl

Fields inherited from interface net.sf.saxon.om.NodeInfo

Constructor Summary

Method Summary

Methods inherited from class com.ihr.xbrl.om.XMLFragment

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

Methods inherited from class java.lang.Object

Field Detail

elementDocNode

name

type

substitutionGroup

nillable

abstract_

UNDEFINED

EMPTY

ALL

EXTENSION

RESTRICTION

SUBSTITUTION

block

fixed

final_

nullConcept

Constructor Detail

XMLElementDefinition

XMLElementDefinition

XMLElementDefinition

XMLElementDefinition

Method Detail

setElementDeclaration

setType

clear

getQName

getParentDocument

getName

setName

getType

getContentValidator

getSimpleContentValidator

setId

getSubstitutionGroup

setSubstitutionGroup

getNillable

setNillable

getAbstract

isAbstract

setAbstract

getFixed

setFixed

getFinal

setFinal

getFinal

getFinal

getBlock

setBlock

getBlock

getBlock

getAttributes

getChildrenType

generateNode

hashCode

equals

getValueKey

getInSubstitutionGroup

getSubstitutionGroupHierarchy

isInSubstitutionGroup

getFriendlyName

getFriendlyName

isTotal

hasChildNodes

getNumberOfChildren

getFirstChild

getLastChild