public class XBRLItem extends XBRLElementDefinition implements java.io.Serializable, XBRLValidation
| Modifier and Type | Class and Description |
|---|---|
static class |
XBRLItem.BalanceType
Enumeration defining the possible content of the xbrli:balance
attribute.
|
static class |
XBRLItem.PeriodType
Enumeration defining the content of the xbrli:periodType attribute but also used to report
the type of a XBRLPeriod object inside an XBRLContext.
|
XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>XBRLValidation.Direction| Modifier and Type | Field and Description |
|---|---|
static javax.xml.namespace.QName |
balance
The value of the balance attribute if it is present.
|
static javax.xml.namespace.QName |
default_
The [default] property.
|
static javax.xml.namespace.QName |
periodTypeAttribute
The [Period Type] property.
|
static javax.xml.namespace.QName |
substitutionGroup
This is xbrli:item.
|
abstract_, ALL, block, elementDocNode, EMPTY, EXTENSION, final_, fixed, name, nillable, nullConcept, RESTRICTION, SUBSTITUTION, type, UNDEFINEDADD_NAMESPACE_INHERIT, baseQName, CONCEPT_LABEL, CONCEPT_QNAME, EASY_TO_READ, ELEMENT_LABEL, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, FACT_VALUE, HIDE_COMMON_ACCURACY, idQName, langQName, nil, NO_POSITION, OrderComparator, OrderComparator2, OrderComparatorReverse, PERIOD_BOP, PERIOD_TYPE, PERIOD_VALUE, RELATIONSHIP_TYPE, RESOURCE_TYPE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER| Constructor and Description |
|---|
XBRLItem(DTSContainer dts)
Creates an item using the properties of the concept received as a parameter
Adds the new concept to the parent taxonomy schema.
|
XBRLItem(XBRLTaxonomy parent,
java.lang.String name,
java.lang.String _default,
XBRLXSDTypeDefinition type,
javax.xml.namespace.QName substitutionGroup,
XBRLItem.PeriodType periodType,
XBRLItem.BalanceType balance,
java.lang.Boolean _abstract,
java.lang.Boolean nillable,
int block,
int _final,
java.lang.String fixed)
Creates and XBRL Item definition.
|
XBRLItem(XMLElementDefinition node)
Creates an item using the properties of the concept received as a parameter.
|
| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Clear.
|
boolean |
equals(java.lang.Object other)
Equals.
|
XBRLItem |
generateNode()
Generate node.
|
XBRLItem.BalanceType |
getBalance()
Access to the [Balance] property of the concept definition.
|
java.lang.String |
getDefault()
Access to the [Default] property.
|
java.util.Iterator<XMLFragment> |
getElements()
Gets the elements.
|
java.util.Iterator<DecoratedQName> |
getExtensibleEnumerationValues()
If this element is extensible enumerable type, this method returns an iterator
of DecoratedQName instances with all available values.
|
java.util.regex.Pattern |
getFilterExpression(XBRLFactItem referenceItem)
RS API contains a Linked lists processor that allows to filter values
in a list using a fact reported value, an item definition whose type
is list (restriction based enumeration facet) and a regular expression
token that might contain #{SOURCE} and will be replaced by the fact
string value.
|
net.sf.saxon.tree.linked.NodeImpl |
getFirstChild() |
java.lang.String |
getFriendlyName()
Gets the friendly name.
|
java.lang.String |
getFriendlyName(int modifiers,
LabelsProvider lp)
Gets the friendly name.
|
java.util.Collection<XBRLItem> |
getInSubstitutionGroup()
Gets the in substitution group.
|
net.sf.saxon.tree.linked.NodeImpl |
getLastChild() |
int |
getNumberOfChildren() |
XBRLItem.PeriodType |
getPeriodType()
returns PeriodType.DURATION or PeriodType.INSTANT
|
XBRLValidationReport |
getValidationReport()
Gets the validation report.
|
boolean |
hasChildNodes() |
int |
hashCode()
Hash code.
|
void |
invalidate()
Invalidate.
|
boolean |
invalidate(XBRLValidation.Direction dir)
Invalidate.
|
boolean |
isEnumerable()
Returns true if this item is enumerable according with the extensible
enumerations specification.
|
boolean |
isFraction()
Returns true or false depending on this XBRLItem is an XBRL fractionItemType or not
This method has been added in order to facilitate the development of the formula
specification.
|
boolean |
isInSubstitutionGroup(javax.xml.namespace.QName name)
Checks if is in substitution group.
|
boolean |
isMonetaryType()
Check if this concept definition is a monetaryItemType or derived from
monetaryItemType in the type hierarchy and return true if this is the
case.
|
boolean |
isNumeric()
Returns true if the type is derived from one of the list
fractionItemType
decimalItemType
floatItemType
doubleItemType
monetaryItemType
sharesItemType
pureItemType
integerItemType
nonPositiveIntegerItemType
negativeIntegerItemType
longItemType
intItemType
shortItemType
byteItemType
nonNegativeIntegerItemType
unsignedLongItemType
unsignedIntItemType
unsignedShortItemType
unsignedByteItemType
positiveIntegerItemType).
|
boolean |
isOnValidation()
Checks if is on validation.
|
boolean |
isPercentageType()
Checks if is percentage type.
|
boolean |
isPureType()
Check if this concept definition is a pureItemType or derived from
pureItemType in the type hierarchy and return true if this is the
case.
|
boolean |
isSharesType()
Check if this concept definition is a sharesItemType or derived from
sharesItemType in the type hierarchy and return true if this is the
case.
|
boolean |
isXBRLType()
Checks if is XBRL type.
|
static java.lang.Boolean |
isXSDTypeNumeric(net.sf.saxon.type.SchemaType typeD,
DTSContainer dts)
Checks if is XSD type numeric.
|
XBRLItem.BalanceType |
setBalance(XBRLItem.BalanceType newValue)
Sets the value of the [Balance] property or reset it if newValue is null.
|
java.lang.String |
setDefault(java.lang.String newValue)
Sets the default.
|
void |
setIsFraction(boolean newValue)
Normally the information about isFraction is obtained from the element data type
but when the element data type cannot be obtained this method can help in setting up
a suitable value so applications can work as if the data type were obtained from the
surrounding node.
|
void |
setIsMonetaryType(boolean newValue)
Sets the flag that indicates this item is of the monetary type.
|
void |
setIsNumeric(boolean newValue)
Normally the information about isNumeric is obtained from the element data type
but when the element data type cannot be obtained this method can help in setting up
a suitable value so applications can work as if the data type were obtained from the
surrounding node.
|
void |
setIsXBRLType(boolean newValue)
Sets the flag that indicates if this concept is of the XBRL derived types or not.
|
XBRLItem.PeriodType |
setPeriodType(XBRLItem.PeriodType newValue)
Sets the value of the [Period Type] property or resets it if newValue is null.
|
XBRLXSDTypeDefinition |
setType(XBRLXSDTypeDefinition type)
Sets the type.
|
XBRLValidationReport |
validate(XBRLPlugInProcessor proc)
Validate.
|
getAbstract, getAttributes, getBlock, getBlock, getBlock, getChildrenType, getContentValidator, getFinal, getFinal, getFinal, getFixed, getName, getNillable, getParentDocument, getQName, getSimpleContentValidator, getSubstitutionGroup, getSubstitutionGroupHierarchy, getType, getValueKey, isAbstract, isInSubstitutionGroup, isTotal, setAbstract, setBlock, setElementDeclaration, setFinal, setFixed, setId, setName, setNillable, setSubstitutionGroupaddAttribute, 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, 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, xEqualaddAttribute, 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, setTypeAnnotationatomize, 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, replacepublic static final javax.xml.namespace.QName substitutionGroup
public static final javax.xml.namespace.QName periodTypeAttribute
public static final javax.xml.namespace.QName default_
public static final javax.xml.namespace.QName balance
public XBRLItem(DTSContainer dts)
dts - the dtspublic XBRLItem(XMLElementDefinition node)
XBRLTaxonomyRootNode.addElement(XMLElementDefinition) if
that is needednode - the nodepublic XBRLItem(XBRLTaxonomy parent, java.lang.String name, java.lang.String _default, XBRLXSDTypeDefinition type, javax.xml.namespace.QName substitutionGroup, XBRLItem.PeriodType periodType, XBRLItem.BalanceType balance, java.lang.Boolean _abstract, java.lang.Boolean nillable, int block, int _final, java.lang.String fixed) throws XBRLValidationException
parent - XBRLTaxonomy parent taxonomyname - String concept name_default - String default value, can be nulltype - XBRLXSDTypeDefinition (xbrli based type)substitutionGroup - QName (item or based on item)periodType - PeriodType enum { UNDEFINED_PERIOD_TYPE | INSTANT | DURATION | FOREVER }balance - BalanceType enum { DEBIT | CREDIT | NO_BALANCE }_abstract - Booleannillable - Booleanblock - int (see XMLElementDefinition)_final - int (see XMLElementDefinition)fixed - String fixed value, can be nullXBRLValidationException - if the new concept definition has XBRL errorspublic void clear()
throws java.lang.Throwable
clear in class XMLElementDefinitionjava.lang.Throwable - the throwablepublic int hashCode()
hashCode in interface net.sf.saxon.om.NodeInfohashCode in class XMLElementDefinitionpublic boolean equals(java.lang.Object other)
equals in interface net.sf.saxon.om.NodeInfoequals in class XMLElementDefinitionother - the otherpublic XBRLXSDTypeDefinition setType(XBRLXSDTypeDefinition type)
setType in class XMLElementDefinitiontype - the typepublic XBRLItem.PeriodType getPeriodType()
public XBRLItem.PeriodType setPeriodType(XBRLItem.PeriodType newValue)
newValue - the integer constant indicating the new value or nullpublic java.lang.String getDefault()
public java.lang.String setDefault(java.lang.String newValue)
newValue - the new valuepublic XBRLItem.BalanceType getBalance()
public XBRLItem.BalanceType setBalance(XBRLItem.BalanceType newValue)
newValue - the new constant for the value of the balance attributepublic boolean isPureType()
public boolean isPercentageType()
public boolean isSharesType()
public boolean isMonetaryType()
public void setIsMonetaryType(boolean newValue)
newValue - booleanpublic boolean isXBRLType()
public void setIsXBRLType(boolean newValue)
newValue - booleanpublic boolean isNumeric()
public static java.lang.Boolean isXSDTypeNumeric(net.sf.saxon.type.SchemaType typeD,
DTSContainer dts)
typeD - the type Ddts - the dtspublic boolean isFraction()
public void setIsNumeric(boolean newValue)
newValue - boolean valuepublic void setIsFraction(boolean newValue)
newValue - boolean valuepublic boolean isInSubstitutionGroup(javax.xml.namespace.QName name)
name - the namepublic XBRLItem generateNode() throws XBRLSerializationException
generateNode in class XMLElementDefinitionXBRLSerializationException - the XBRL serialization exceptionpublic java.util.Iterator<XMLFragment> getElements()
getElements in class XMLFragmentpublic java.util.Collection<XBRLItem> getInSubstitutionGroup()
getInSubstitutionGroup in class XMLElementDefinitionpublic java.lang.String getFriendlyName()
getFriendlyName in class XMLElementDefinitionpublic java.lang.String getFriendlyName(int modifiers,
LabelsProvider lp)
getFriendlyName in class XMLElementDefinitionmodifiers - the modifierslp - the lppublic XBRLValidationReport getValidationReport()
getValidationReport in interface XBRLValidationpublic XBRLValidationReport validate(XBRLPlugInProcessor proc)
validate in interface XBRLValidationproc - the procpublic void invalidate()
invalidate in interface XBRLValidationpublic boolean invalidate(XBRLValidation.Direction dir)
invalidate in interface XBRLValidationdir - the dirpublic boolean isOnValidation()
isOnValidation in interface XBRLValidationpublic java.util.regex.Pattern getFilterExpression(XBRLFactItem referenceItem)
referenceItem - the reference itempublic boolean isEnumerable()
public java.util.Iterator<DecoratedQName> getExtensibleEnumerationValues()
public final boolean hasChildNodes()
hasChildNodes in interface net.sf.saxon.om.NodeInfohasChildNodes in class net.sf.saxon.tree.linked.NodeImplpublic final int getNumberOfChildren()
public final net.sf.saxon.tree.linked.NodeImpl getFirstChild()
getFirstChild in interface net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>getFirstChild in class net.sf.saxon.tree.linked.NodeImplpublic final net.sf.saxon.tree.linked.NodeImpl getLastChild()
getLastChild in class net.sf.saxon.tree.linked.NodeImplCopyright 2006-2015 Reporting Standard S.L., C/ Torrecilla del Puerto 1, 28043, Madrid, Espaņa