public class XBRLTaxonomy extends XBRLDocument
The [Parent] property is the parent class XBRLDocument.
XBRLDocument.LockInfo, XBRLDocument.XBRLDocumentType
XBRLValidation.Direction
Modifier and Type | Field and Description |
---|---|
static javax.xml.namespace.QName |
redefine
The Constant redefine.
|
static javax.xml.namespace.QName |
schemaNodeName
The document node name.
|
static net.sf.saxon.om.StructuredQName |
sqnSchemaNodeName
The Constant sqnSchemaNodeName.
|
Constructor and Description |
---|
XBRLTaxonomy(DTSContainer dts,
boolean isDynamic)
Creates a new empty XBRLTaxonomy instance.
|
XBRLTaxonomy(XMLDocumentURI docURI,
boolean bAddToCache)
Creates a new XBRLTaxonomy instance from an XMLDocumentURI.
|
Modifier and Type | Method and Description |
---|---|
void |
addArcroleType(XBRLArcroleType arcrole)
Adds a new arcrole type to the set of arcrole types defined in this
taxonomy.
|
XMLElementDefinition |
addElement(XMLElementDefinition newElement)
Add a new element to the taxonomy.
|
void |
addGlobalAttribute(XMLFragment attributeDefinitionHeaderNode)
Adds a new global attribute definition to this taxonomy schema.
|
void |
addGlobalAttributeGroup(XMLFragment attributeGroupDefinitionHeaderNode)
Adds a new global attributeGroup definition to this taxonomy schema.
|
void |
addGlobalGroup(XMLFragment groupDefinitionHeaderNode)
Adds a new global attributeGroup definition to this taxonomy schema.
|
void |
addGlobalType(XMLFragment typeDefinitionHeaderNode)
Adds a new global type definition to this taxonomy schema.
|
void |
addImport(XBRLImport imp)
Adds a new import to this taxonomy.
|
void |
addInclude(XBRLInclude inc)
Adds an XBRLInclude to this taxonomy.
|
void |
addLinkbase(XBRLLinkbase linkbase)
Adds a linkbase object to this taxonomy.
|
void |
addRoleType(XBRLRoleType role)
Adds a new role type to the set of role types defined in this
taxonomy.
|
void |
clear()
Clear.
|
void |
delElement(XMLElementDefinition element)
Deletes an element from the taxonomy
This function will not delete the relationships the element participates on.
|
boolean |
delGlobalAttribute(java.lang.String name)
Removes a Global attribute definition from this taxonomy schema.
|
boolean |
delGlobalAttributeGroup(java.lang.String name)
Removes a Global attributeGroup definition from this taxonomy schema.
|
boolean |
delGlobalGroup(java.lang.String name)
Removes a Global group definition from this taxonomy schema.
|
boolean |
delGlobalType(java.lang.String name)
Removes a Global Type definition from this taxonomy schema.
|
void |
discoverDTS(XBRLDTSDocument parent)
Discover DTS.
|
XMLDocumentImpl |
generateDocNode()
Generate doc node.
|
XBRLArcroleType |
getArcroleTypeByURI(java.lang.String uri)
Access to an arcrole type definition for a given URI if that arcrole type exists on
this taxonomy. returns null if there is no such arcrole type for the given URI.
|
java.util.Iterator<XBRLArcroleType> |
getArcroleTypes()
Returns an iterator over all arcrole types defined in this taxonomy.
|
java.util.Iterator<XMLElementDefinition> |
getConcepts()
Access to the [Concepts] property
This method does not return non XBRL concep definitions.
|
XBRLDocument.XBRLDocumentType |
getDTSDocumentType()
Gets the DTS document type.
|
java.lang.String |
getDTSDocumentTypeName()
Gets the DTS document type name.
|
XMLElementDefinition |
getElementDefinitionById(java.lang.String id)
Finds the element definition based on the element name and returns
an XMLDocument that can be an XMLDocument, an XBRLItem or an XBRLTuple
Returns null if not found.
|
XMLElementDefinition |
getElementDefinitionByName(java.lang.String name)
Finds the element definition based on the element name and returns
an XMLDocument that can be an XMLFragment, an XBRLItem or an XBRLTuple
Returns null if not found.
|
java.lang.String |
getFriendlyName()
Gets the friendly name.
|
java.util.Iterator<java.lang.String> |
getGlobalAtributeGroups()
Access to an iterator over all global attribute groups.
|
XMLFragment |
getGlobalAttributeByName(java.lang.String name)
Returns a global attribute defined in this taxonomy schema by its name.
|
XMLFragment |
getGlobalAttributeGroupByName(java.lang.String name)
Returns a global attributeGroup defined in this taxonomy schema by its name.
|
java.util.Iterator<java.lang.String> |
getGlobalAttributes()
Access to an iterator over all global attributes.
|
XMLFragment |
getGlobalGroupByName(java.lang.String name)
Returns a global group defined in this taxonomy schema by its name.
|
java.util.Iterator<java.lang.String> |
getGlobalGroups()
Access to an iterator over all element groups defined.
|
XMLFragment |
getGlobalTypeByName(java.lang.String name)
Returns a global type defined in this taxonomy schema by its name or null if the taxonomy
schema has no a definition for a global type under the type name used in the name parameter.
|
java.util.Iterator<java.lang.String> |
getGlobalTypes()
Access to an iterator over all global types defined in the taxonomy.
|
XBRLTaxonomy |
getImport(java.net.URI namespace)
Return the XBRLTaxonomy imported for the namespace or null if the schema for the namespace is not imported.
|
java.util.Iterator<XBRLImport> |
getImports()
Return an iterator of all defined imports.
|
java.util.Iterator<XBRLInclude> |
getIncludes()
Access to the includes declared on this taxonomy.
|
java.util.Iterator<XBRLItem> |
getItems()
Access to the [Items] property.
|
java.util.Iterator<XBRLLinkbase> |
getLinkbases()
Return an iterator of all defined linkbases.
|
int |
getNumberOfItemDeclarations()
Returns the number of XBRL items defined in this XBRLTaxonomy.
|
int |
getNumberOfTupleDeclarations()
Returns the number of XBRL tuples defined in this XBRLTaxonomy.
|
XBRLRoleType |
getRoleTypeByURI(java.lang.String uri)
Access to a role type definition for a given URI if that role type exists on
this taxonomy. returns null if there is no such role type for the given URI.
|
java.util.Iterator<XBRLRoleType> |
getRoleTypes()
Returns an iterator over all role types defined in this taxonomy.
|
com.saxonica.ee.schema.PreparedSchema |
getSchema()
Deprecated.
|
java.lang.String |
getTargetNamespace()
Access to the [Namespace] Property.
|
XBRLTaxonomyRootNode |
getTaxonomyRootNode()
Access to the xs:schema node of this XBRLTaxonomy.
|
java.util.Iterator<XBRLTuple> |
getTuples()
Access to the [Tuples] property.
|
static XBRLTaxonomy |
LateLoadXBRLTaxonomy(DTSContainer dts,
java.net.URI resolvedURI,
boolean bAddToCache,
XBRLDTSDocument parent)
Creates a new XBRLTaxonomy instance.
|
void |
readInfoset()
Read infoset.
|
void |
removeArcroleType(XBRLArcroleType arcrole)
Removes an arcrole type from the set of arcrole types defined in this taxonomy.
|
void |
removeImport(XBRLImport imp)
Remove an existing import.
|
boolean |
removeInclude(XBRLInclude inc)
Removes am include form this taxonomy.
|
void |
removeLinkbase(XBRLLinkbase linkbase)
Removes a linkbase object that is referenced in this taxonomy.
|
void |
removeRoleType(XBRLRoleType role)
Removes a role type from the set of role types defined in this taxonomy.
|
void |
setRootNode(XBRLTaxonomyRootNode taxonomy)
Sets the root node.
|
void |
setTargetNamespace(java.lang.String targetNamespace)
Sets or changes the targetNamespace for this schema.
|
addComment, addIdOfElement, addIdOfElement, addParent, changeElementId, checkCleanDocumentInfo, createDocument, createDocument, createDocument, createDynamicDocument, delParent, equals, generateId, getAllUsedIds, getComments, getDocumentInfo, getDTS, getElementById, getElementsById, getOrCreateTableId, getParents, getRoleRef, getTreeModel, hashCode, isContentModified, isDynamic, isIdUsed, isOfficialURI, lock, registerChangeIdListener, registerChangeIdListener, release, removeComments, removeIdOfElement, removeIdOfElement, resolveURI, save, save, save, setComments, setLockInfo, setModified, setReadingInfoset, toString, unregisterChangeIdListener, unsetLockInfo, updateXML
addChild, delChild, evaluateList, getBase, getChildren, getContainer, getDocument, getDocumentRootNode, getDocumentURI, getDocumentURICode, getDTSDiscoveryInfo, getDTSKey, getLocalFile, getOldDocument, getPackageName, getPackageVersion, getPrefix, getPrefixes, getValidationReport, getXBRLDocumentInfo, getXPathToRoot, invalidate, invalidate, isInDTS, isOnValidation, setContainer, setDocumentURICode, setDTSDiscoveryInfo, setDTSKey, setNodeName, setRootNode, setURI, setXBRLDocumentInfo, validate
public static final javax.xml.namespace.QName schemaNodeName
public static final net.sf.saxon.om.StructuredQName sqnSchemaNodeName
public static final javax.xml.namespace.QName redefine
public XBRLTaxonomy(XMLDocumentURI docURI, boolean bAddToCache) throws DTSDiscoveryException
docURI
- the doc uribAddToCache
- the b add to cacheDTSDiscoveryException
- the DTS discovery exceptionpublic XBRLTaxonomy(DTSContainer dts, boolean isDynamic)
The taxonomy will not have any parent object and will not be added to the set of
taxonomies that belongs to the DTSContainer object. See DTSContainer.addDocumentToDTS(XBRLDTSDocument)
in order to allow DTSContainer.save()
to serialize the taxonomy
to XML nodes. Don't forget to set a file name to this taxonomy before calling
the save method. see XMLDocumentURI.setURI(URI)
for more information.
dts
- the DTSContainer object.isDynamic
- true when the document is created programmaticallypublic static XBRLTaxonomy LateLoadXBRLTaxonomy(DTSContainer dts, java.net.URI resolvedURI, boolean bAddToCache, XBRLDTSDocument parent) throws DTSDiscoveryException
dts
- current DTSContainer for the new XBRLTaxonomyresolvedURI
- the resolved URIbAddToCache
- boolean, true if the document should be added to the DTSContainer cache of read documents.parent
- XBRLDTSDocument that is the parent of this document, this is only used if there are errors reading the document. Can be null.DTSDiscoveryException
- the DTS discovery exceptionpublic void clear() throws java.lang.Throwable
clear
in interface XBRLDTSDocument
clear
in class XBRLDocument
java.lang.Throwable
- the throwable@Deprecated public com.saxonica.ee.schema.PreparedSchema getSchema()
public java.lang.String getTargetNamespace()
public void setRootNode(XBRLTaxonomyRootNode taxonomy)
taxonomy
- the new root nodepublic void setTargetNamespace(java.lang.String targetNamespace)
targetNamespace
- the new target namespacepublic XBRLDocument.XBRLDocumentType getDTSDocumentType()
getDTSDocumentType
in class XBRLDocument
public java.util.Iterator<XMLElementDefinition> getConcepts()
public java.util.Iterator<XBRLItem> getItems()
public java.util.Iterator<XBRLTuple> getTuples()
public XMLElementDefinition addElement(XMLElementDefinition newElement)
newElement
- the new elementpublic void delElement(XMLElementDefinition element)
This function will not delete the relationships the element participates on.
If the desire is to remove the concept from the taxonomy and the relationships
form existing extended links use the DTSContainer.delConcept(QName)
method instead.
element
- the elementpublic XMLElementDefinition getElementDefinitionByName(java.lang.String name)
This method is deprecated, use the same method in the taxonomy root node
getTaxonomyRootNode()
.{@link XBRLTaxonomyRootNode#getElementDefinitionByName(String)
name
- Element namepublic XMLElementDefinition getElementDefinitionById(java.lang.String id) throws XBRLValidationException
id
- Element idXBRLValidationException
- the XBRL validation exceptionpublic java.lang.String getDTSDocumentTypeName()
getDTSDocumentTypeName
in class XBRLDocument
public java.util.Iterator<XBRLInclude> getIncludes()
public XBRLTaxonomyRootNode getTaxonomyRootNode()
public java.util.Iterator<XBRLImport> getImports()
public XMLFragment getGlobalTypeByName(java.lang.String name)
name
- the type namepublic java.util.Iterator<java.lang.String> getGlobalTypes()
public XMLFragment getGlobalAttributeByName(java.lang.String name)
name
- the attribute namepublic java.util.Iterator<java.lang.String> getGlobalAttributes()
public XMLFragment getGlobalAttributeGroupByName(java.lang.String name)
name
- the attributeGroup namepublic java.util.Iterator<java.lang.String> getGlobalAtributeGroups()
public XMLFragment getGlobalGroupByName(java.lang.String name)
name
- the group namepublic java.util.Iterator<java.lang.String> getGlobalGroups()
public boolean delGlobalType(java.lang.String name)
name
- the global type namepublic boolean delGlobalAttribute(java.lang.String name)
name
- the global attribute namepublic boolean delGlobalAttributeGroup(java.lang.String name)
name
- the global attributeGroup namepublic boolean delGlobalGroup(java.lang.String name)
name
- the global group namepublic void addGlobalType(XMLFragment typeDefinitionHeaderNode)
The parameter must contain all nodes representing the type definition as nested XMLFragment objects
typeDefinitionHeaderNode
- the first XMLFragment object. Must be a complexType node or
a simpleType node with an attribute o name "name". the attribute value will be
used in order to obtain the type name.public void addGlobalAttribute(XMLFragment attributeDefinitionHeaderNode)
The parameter must contain all nodes representing the attribute definition as nested XMLFragment objects
attributeDefinitionHeaderNode
- the first XMLFragment object. Must be a xs:attribute node
with an attribute named "name". the attribute value will be
used in order to obtain the attribute name.public void addGlobalAttributeGroup(XMLFragment attributeGroupDefinitionHeaderNode)
The parameter must contain all nodes representing the attributeGroup definition as nested XMLFragment objects
attributeGroupDefinitionHeaderNode
- the first XMLFragment object. Must be a xs:attributeGroup node
with an attribute named "name". the attribute value will be
used in order to obtain the attribute name.public void addGlobalGroup(XMLFragment groupDefinitionHeaderNode)
The parameter must contain all nodes representing the attributeGroup definition as nested XMLFragment objects
groupDefinitionHeaderNode
- the first XMLFragment object. Must be a xs:attributeGroup node
with an attribute named "name". the attribute value will be
used in order to obtain the attribute name.public XBRLTaxonomy getImport(java.net.URI namespace)
namespace
- the namespacepublic java.util.Iterator<XBRLLinkbase> getLinkbases()
public void addLinkbase(XBRLLinkbase linkbase)
linkbase
- the linkbasepublic void removeLinkbase(XBRLLinkbase linkbase)
linkbase
- to removepublic void discoverDTS(XBRLDTSDocument parent) throws DTSDiscoveryException, com.rs.lic.LicenseVerificationException
discoverDTS
in interface XBRLDTSDocument
discoverDTS
in class XBRLDocument
parent
- the parentDTSDiscoveryException
- the DTS discovery exceptioncom.rs.lic.LicenseVerificationException
- the license verification exceptionpublic void addRoleType(XBRLRoleType role)
The XBRLRoleType object automatically calls this method when a parent is set to a role type.
role
- XBRLRoleType to be addedpublic void removeRoleType(XBRLRoleType role)
The XBRLRoleType object automatically calls this method when a parent is set to a role type.
role
- XBRLRoleType to be removedpublic java.util.Iterator<XBRLRoleType> getRoleTypes()
public XBRLRoleType getRoleTypeByURI(java.lang.String uri)
uri
- as a Stringpublic void addArcroleType(XBRLArcroleType arcrole)
The XBRLArcroleType object automatically calls this method when a parent is set to an arcrole type.
arcrole
- XBRLArcroleType to be addedpublic void removeArcroleType(XBRLArcroleType arcrole)
The XBRLArcroleType object automatically calls this method when a parent is set to an arcrole type.
arcrole
- XBRLArcroleType to be removedpublic java.util.Iterator<XBRLArcroleType> getArcroleTypes()
public XBRLArcroleType getArcroleTypeByURI(java.lang.String uri)
uri
- as a Stringpublic void readInfoset() throws XBRLValidationException
readInfoset
in class XBRLDocument
XBRLValidationException
- the XBRL validation exceptionpublic int getNumberOfItemDeclarations()
This is concept definitions that are in the xbrli:item substitution group or has xbrli:item on any on its ancestors in the substitution group hierarchy.
public int getNumberOfTupleDeclarations()
This is concept definitions that are in the xbrli:tuple substitution group or has xbrli:tuple on any on its ancestors in the substitution group hierarchy.
public XMLDocumentImpl generateDocNode() throws XBRLSerializationException
generateDocNode
in class XBRLDocument
XBRLSerializationException
- the XBRL serialization exceptionpublic void removeImport(XBRLImport imp)
imp
- XBRLImportpublic void addInclude(XBRLInclude inc)
inc
- the incpublic boolean removeInclude(XBRLInclude inc)
inc
- the incpublic void addImport(XBRLImport imp) throws XBRLInconsistentDTSException
imp
- XBRLImportXBRLInconsistentDTSException
- the XBRL inconsistent dts exceptionpublic java.lang.String getFriendlyName()
getFriendlyName
in class XMLDocumentURI
Copyright 2006-2015 Reporting Standard S.L., C/ Torrecilla del Puerto 1, 28043, Madrid, Espaņa