com.batavia.xbrl.taxonomy
Interface DiscoverableTaxonomySet

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

DimensionalDiscoverableTaxonomySet

public interface DiscoverableTaxonomySet
extends java.io.Serializable

While a taxonomy defines reporting concepts, it does not contain the actual values of facts based on the defined concepts. The fact values are contained in XBRL instances and are referred to as “facts”. Besides the actual value of a fact, such as “cash is 500,000”, the XBRL instance provides contextual information necessary for interpreting the fact values. For numeric facts, the XBRL instance also documents measurement accuracy and measurement units.

An instance document can be supported by more than one taxonomy. Also, taxonomies can be interconnected, extending and modifying each other in various ways. Generally, it is necessary to consider multiple related taxonomies together when interpreting an XBRL instance. The set of related taxonomies supporting an XBRL instance is called a Discoverable Taxonomy SetImpl (DTS). A DTS is a collection of taxonomy schemas and linkbases.

The bounds of a DTS are determined by starting from some set of documents (instance, taxonomy schema, or linkbase) and following DTS discovery rules. Although an instance document can be the starting point for DTS discovery, the instance document itself is not part of the DTS. Taxonomy schemas and linkbases that are used as starting points for DTS discovery are part of the DTS that they discover. DTS rules of discovery:

Taxonomy schemas in the DTS are those:

1. referenced directly from an instance document using the schemaRef, roleRef or arcroleRef element. The xlink:href attribute on the schemaRef, roleRef or arcroleRef element contains the URL of the taxonomy schema that is discovered. Every taxonomy schema that is referenced by the schemaRef, roleRef or arcroleRef element MUST be discovered.

2. referenced from a discovered taxonomy schema via an XML Schema import or include element. Every taxonomy schema that is referenced by an import or include element in a discovered taxonomy schema MUST be discovered.

3. referenced from a discovered linkbase document via a loc element. Every taxonomy schema that is referenced by an xlink:href attribute on a loc element in a discovered linkbase MUST be discovered.

4. referenced from a discovered linkbase document via a roleRef element. Every taxonomy schema that is referenced by an xlink:href attribute on a roleRef element in a discovered linkbase MUST be discovered.

5. referenced from a discovered linkbase document via an arcroleRef element. Every taxonomy schema that is referenced by an xlink:href attribute on an arcroleRef element in a discovered linkbase MUST be discovered.

Linkbase documents in the DTS are those:

1. referenced directly from an XBRL instance via the linkbaseRef element. The xlink:href attribute contains the URL of the linkbase document being discovered. Every linkbase that is referenced by the linkbaseRef element MUST be discovered.

2. referenced from a discovered taxonomy schema via the linkbaseRef element. The xlink:href attribute contains the URL of the linkbase being discovered. Every linkbase that is referenced by the linkbaseRef element MUST be discovered.

3. that occur at the XPath "schema/annotation/appinfo/*" in a discovered taxonomy schema (Throughout this specification, schema, annotation and appinfo are all elements defined in the XML Schema namespace).

4. referenced from a discovered linkbase document via a loc element. Every linkbase that contains a resource that is referenced by an xlink:href attribute on a loc element in a discovered linkbase MUST be discovered.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	addBaseDTS(DiscoverableTaxonomySet baseDTS, java.lang.String urlMainSchema)
void	addLinkbase(java.lang.String parentUrl, java.lang.String URL, LinkbaseContainer aPart) Add the linkbaseContainer to this DTS.
void	addTaxonomySchema(java.lang.String parentUrl, java.lang.String URL, Root aPart) Add the schema to this DTS.
void	clear()
void	completeInstance(Xbrl xbrlElement) complete xbrlElement with the content of the DTS for PTVI.
InstanceDocument	createEmptyInstanceDocument() Create an empty instancedocument with the mainTaxonomySchema as default namespace
InstanceDocument	createPopulatedInstanceDocument(boolean includeDefaultValues) Create an populated instancedocument without data with the mainTaxonomySchema as default namespace all possible Facts are created and added.
void	discoverDocument(java.lang.String referringSchemaNamespaceUri, java.lang.String parentURL, TaxonomyDocument parent)
void	discoverDocument(java.lang.String parentURL, TaxonomyDocument parent) Use the parent to discover the whole DTS Taxonomy schemas in the DTS are those: 1. referenced directly from an instance document using the schemaRef, roleRef or arcroleRef element.
void	discoverDocumentRoot(java.lang.String parentURL, Xbrl root) Discover this DTS based on the given xbrl element and the parentURL that identified the document the xbrl root is contained by.
void	discoverLinkbase(java.lang.String parentUrl, java.lang.String href, LinkbaseDocument linkbaseDoc) Discover the given linkbase document that was found through the given href which was located in the document found at the location of parentUrl.
void	discoverNetworks() Discover the networks of nodes/concepts that are connected by the arcs in this DTS: check the networks with the cycles allowed attribute on the arcRoleType elements The concepts that are related do not know they are!
TaxonomyDocument	discoverUrl(java.lang.String targetNamespaceUri, java.lang.String parentUrl, java.lang.String URL) Discover the TaxonomyDocument found at the URL relative to the parentURL for this DTS.
java.util.List	findNetworks(java.lang.String linkLocalName)
java.util.List	findNetworks(java.lang.String arcLocalName, java.lang.String arcNamespace, java.lang.String arcRole, java.lang.String linkLocalName, java.lang.String linkNamespace, java.lang.String linkRole) Find the networks constructed with the given arguments, arc local name and namespace, arcRole, link local name and namespace, linkRole.
java.util.List	findNetworksFromTo(IdHolder source, IdHolder target, java.lang.String arcLocalName, java.lang.String arcNamespace, java.lang.String arcRole, java.lang.String linkLocalName, java.lang.String linkNamespace, java.lang.String linkRole)
java.util.List	findNetworksUsingConcept(Concept concept, java.lang.String linkLocalName) Find the networks in which the given concept is used for the given link local name. return a list with the found networks
java.util.List	findNetworksUsingConcept(Concept concept, java.lang.String arcLocalName, java.lang.String arcNamespace, java.lang.String arcRole, java.lang.String linkLocalName, java.lang.String linkNamespace, java.lang.String linkRole) Find the networks in which the given concept is used for the given arguments, arc local name and namespace, arcRole, link local name and namespace, linkRole.
java.util.List	findNetworksUsingConceptWithFilters(Concept concept, java.lang.String linkLocalName, java.util.List requiredExtendedLinkSubRoleUris) Find the networks in which the given concept is used for the given link local name and filters with sub uris. return a list with the found networks
java.util.List	findNetworksUsingConceptWithFilters(Concept concept, java.lang.String arcLocalName, java.lang.String arcNamespace, java.lang.String arcRole, java.lang.String linkLocalName, java.lang.String linkNamespace, java.lang.String linkRole, java.util.List requiredExtendedLinkSubRoleUris) Find the networks in which the given concept is used for the given arguments, arc local name and namespace, arcRole, link local name and namespace, linkRole and filters with sub uris.
java.util.List	findNetworksWithFilters(java.lang.String linkLocalName, java.util.List requiredExtendedLinkSubRoleUris)
java.util.List	findNetworksWithFilters(java.lang.String arcLocalName, java.lang.String arcNamespace, java.lang.String arcRole, java.lang.String linkLocalName, java.lang.String linkNamespace, java.lang.String linkRole, java.util.List requiredExtendedLinkSubRoleUris) Find the networks constructed with the given arguments, arc local name and namespace, arcRole, link local name and namespace, linkRole and filters with sub uris.
java.util.List	findRolesUsingConcept(Concept concept, java.lang.String linkLocalName) Find the role uris in whose networks the given concept is used for the given link local name. return a list with the found uris
java.util.List	findRolesUsingConceptWithFilters(Concept concept, java.lang.String linkLocalName, java.util.List requiredExtendedLinkSubRoleUris) Find the role uris in whose networks the given concept is used for the given link local name and filters with sub uris. return a list with the found uris
XbrlType	findWrapper(com.sun.msv.datatype.xsd.XSDatatype wrappedXmlSchemaDatatype) Get the XbrlConceptType that uses the given XSDatatype
java.util.Map	getAllDiscoveredNetworks()
ArcroleType	getArcRoleType(java.lang.String uri)
java.util.Map	getCalculationMaps(Concept aConcept) Get a Map with the calculation related concepts(contributing concepts) for the given summation concept.
Concept	getConcept(FullyQualifiedName qName) Get the required Concept from the knowConcepts map.
Declaration	getDeclaration(FullyQualifiedName qName)
java.util.List	getDiscoveredNetworks(NetworkIndicator id) Get the collection of discovered notworks in this DTS that can be identified by the given NetworkIndicator
java.lang.String	getDtsKey()
ValidationDocument	getDtsMessages()
java.util.List	getDtsUrls()
java.util.Map	getEssenceAliasDefinition(Concept aConcept) Get a Map with the essence-alias definitions for the given concept.
java.util.Map	getGeneralSpecialDefinition(Concept aConcept) Get a Map with the general-special definitions for the given concept.
Group	getGroup(FullyQualifiedName qName)
IdHolder	getIdHolder(java.lang.String baseUrl, java.lang.String xlinkHref, InstanceDocument instance) use the xlinkHref to find the documentroot and the id-ed fragment
java.util.Map	getIndicators()
java.util.Map	getKnownArcroleTypes()
java.util.Map	getKnownAttributeGroups()
java.util.Map	getKnownAttributes()
java.util.Map	getKnownConcepts()
Set	getKnownConceptsInTupleConceptsQnames()
java.util.Map	getKnownDeclarations()
java.util.Map	getKnownGroups()
java.util.Map	getKnownItemTupleConcepts()
java.util.Map	getKnownRoleTypes()
java.util.Map	getKnownTypes()
java.util.Map	getKnownXbrlTypes()
java.util.List	getLabels(Concept aConcept) Get the collection of Label resources in the DTS that apply to the given concept.
LinkbaseContainer	getLinkBase(java.lang.String parentUrl, java.lang.String URL) get the LinkbaseContainer that was found at the URL location relative to the parentUrl.
java.util.Map	getLinkbases() Get the linkbases that are contained by this DTS mapped to their document href
TaxonomySchema	getMainTaxonomySchema()
java.util.Map	getNetworkBaseSets()
java.util.Map	getNetworks()
java.util.List	getOrderedRoles()
java.util.List	getReferences(Concept aConcept) Get the collection of reference resources in the DTS that apply to the given concept.
java.util.Map	getRequiresElementDefinition(Concept aConcept) Get a Map with the requires-element definitions for the given concept.
RoleType	getRoleType(java.lang.String uri) get the roletype from this DTS that has the given uri
java.util.Map	getSimilarTuplesDefinition(Concept aConcept) Get a Map with the similar tuple definitions for the given concept.
java.util.Map	getSubstitutions()
java.util.List	getSubstitutions(Declaration declaration) gets a list with ALL substitutions for the given declaration
java.util.List	getSupportedLanguageCodes()
java.util.Map	getTaxonomySchemas() Get the schemas that are contained by this DTS mapped to their document href
java.util.List	getTuplesWithRefTo(Concept aConcept) Get a list of tuples that contains the given Concept
XbrlType	getType(FullyQualifiedName qName) Get the required type from the knowTypes map.
com.sun.msv.datatype.xsd.XSDatatype	getXSDatatypeByName(java.lang.String name, XmlParticle parent) Get the XSDatatype that has the given name.
java.util.Map	getXSDatatypes()
java.util.Map	getXSDatatypesToConceptTypes()
boolean	isValid() Return true when the DTS is valid
boolean	isXbrlInstanceSchemaImported()
void	putXSDatatypeByName(FullyQualifiedName qName, com.sun.msv.datatype.xsd.XSDatatype wrappedXmlSchemaDatatype, XbrlType wrappingXbrlConceptType) Make sure the wrappingXbrlConceptType can be retreived for later use based on the name for the target namespace Make sure the wrappedXmlSchemaDatatype can be retreived for later use based on the given qName.
void	removeLinkbase(java.lang.String URI) Remove the linkbase from this DTS that was found at the absolute location URI.
void	removeTaxonomySchema(java.lang.String URI) Remove the schema from this DTS that was found at the absolute location URI.
void	setDtsKey(java.lang.String dtsKey)
void	setKnownConceptsInTupleConcepts(Set knownConceptsInTupleConcepts)
void	setMainTaxonomySchema(TaxonomySchema mainTaxonomySchema)
void	setValid(boolean valid)
void	setXbrlInstanceSchemaImported(boolean xbrlInstanceSchemaImported)
void	setXSDatatypes(java.util.Map datatypes)
void	setXSDatatypesToConceptTypes(java.util.Map datatypesToConceptTypes)
boolean	validate() Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessages collection.
boolean	validateInstance(Xbrl xbrlElement, ValidationDocument msgs) validate xbrlElement with the content of the DTS.

Method Detail

getSubstitutions

java.util.List getSubstitutions(Declaration declaration)

gets a list with ALL substitutions for the given declaration

Returns:

a List with Declaration Objects

getDtsKey

java.lang.String getDtsKey()

Returns:

Returns the dtsKey.

setDtsKey

void setDtsKey(java.lang.String dtsKey)

Parameters:

dtsKey - The dtsKey to set.

getDtsMessages

ValidationDocument getDtsMessages()

Returns:

Returns the dtsMessages.

discoverDocumentRoot

void discoverDocumentRoot(java.lang.String parentURL,
                          Xbrl root)

Discover this DTS based on the given xbrl element and the parentURL that identified the document the xbrl root is contained by.

Parameters:

parentURL -

root -

getEssenceAliasDefinition

java.util.Map getEssenceAliasDefinition(Concept aConcept)

Get a Map with the essence-alias definitions for the given concept. The map contains lists of the defined alias concepts for this given essence concept. The lists are mapped to networkindicators.

Parameters:

aConcept -

Returns:

Map with lists of concepts.

getSimilarTuplesDefinition

java.util.Map getSimilarTuplesDefinition(Concept aConcept)

Get a Map with the similar tuple definitions for the given concept. The map contains lists of the defined similar tuple concepts for this given tuple concept. The lists are mapped to networkindicators.

Parameters:

aConcept -

Returns:

Map with lists of concepts.

getRequiresElementDefinition

java.util.Map getRequiresElementDefinition(Concept aConcept)

Get a Map with the requires-element definitions for the given concept. The map contains lists of the defined required concepts for this given concept. The lists are mapped to networkindicators.

Parameters:

aConcept -

Returns:

Map with lists of concepts.

getGeneralSpecialDefinition

java.util.Map getGeneralSpecialDefinition(Concept aConcept)

Get a Map with the general-special definitions for the given concept. The map contains lists of the defined special concepts for this given concept. The lists are mapped to networkindicators.

Parameters:

aConcept -

Returns:

Map with lists of concepts.

discoverUrl

TaxonomyDocument discoverUrl(java.lang.String targetNamespaceUri,
                             java.lang.String parentUrl,
                             java.lang.String URL)

Discover the TaxonomyDocument found at the URL relative to the parentURL for this DTS.

Parameters:

parentUrl -

URL -

Returns:

TaxonomyDocument

getReferences

java.util.List getReferences(Concept aConcept)

Get the collection of reference resources in the DTS that apply to the given concept.

Parameters:

aConcept -

Returns:

List

getLabels

java.util.List getLabels(Concept aConcept)

Get the collection of Label resources in the DTS that apply to the given concept.

Parameters:

aConcept -

Returns:

List

getCalculationMaps

java.util.Map getCalculationMaps(Concept aConcept)

Get a Map with the calculation related concepts(contributing concepts) for the given summation concept. The map contains Maps of the defined contributing concepts for this given concept. The Concepts map to the weight they have in the calculation of the summation. The Maps are mapped to networkindicators.

Parameters:

aConcept -

Returns:

Map with lists of concepts.

getType

XbrlType getType(FullyQualifiedName qName)

Get the required type from the knowTypes map.

Parameters:

qName -

Returns:

getTuplesWithRefTo

java.util.List getTuplesWithRefTo(Concept aConcept)

Get a list of tuples that contains the given Concept

Parameters:

aConcept -

Returns:

Tuple

getConcept

Concept getConcept(FullyQualifiedName qName)

Get the required Concept from the knowConcepts map.

Parameters:

qName -

Returns:

Concept

getIdHolder

IdHolder getIdHolder(java.lang.String baseUrl,
                     java.lang.String xlinkHref,
                     InstanceDocument instance)

use the xlinkHref to find the documentroot and the id-ed fragment

Parameters:

xlinkHref -

Returns:

discoverNetworks

void discoverNetworks()

Discover the networks of nodes/concepts that are connected by the arcs in this DTS: check the networks with the cycles allowed attribute on the arcRoleType elements The concepts that are related do not know they are! If the networks are valid, create them, else throw exception

createEmptyInstanceDocument

InstanceDocument createEmptyInstanceDocument()

Create an empty instancedocument with the mainTaxonomySchema as default namespace

Returns:

createPopulatedInstanceDocument

InstanceDocument createPopulatedInstanceDocument(boolean includeDefaultValues)

Create an populated instancedocument without data with the mainTaxonomySchema as default namespace all possible Facts are created and added.

Returns:

discoverDocument

void discoverDocument(java.lang.String parentURL,
                      TaxonomyDocument parent)

Use the parent to discover the whole DTS Taxonomy schemas in the DTS are those: 1. referenced directly from an instance document using the schemaRef, roleRef or arcroleRef element. The xlink:href attribute on the schemaRef, roleRef or arcroleRef element contains the URL of the taxonomy schema that is discovered. Every taxonomy schema that is referenced by the schemaRef, roleRef or arcroleRef element MUST be discovered. 2. referenced from a discovered taxonomy schema via an XML Schema import or include element. Every taxonomy schema that is referenced by an import or include element in a discovered taxonomy schema MUST be discovered. 3. referenced from a discovered linkbase document via a loc element. Every taxonomy schema that is referenced by an xlink:href attribute on a loc element in a discovered linkbase MUST be discovered. 4. referenced from a discovered linkbase document via a roleRef element. Every taxonomy schema that is referenced by an xlink:href attribute on a roleRef element in a discovered linkbase MUST be discovered. 5. referenced from a discovered linkbase document via an arcroleRef element. Every taxonomy schema that is referenced by an xlink:href attribute on an arcroleRef element in a discovered linkbase MUST be discovered. Linkbase documents in the DTS are those: 1. referenced directly from an XBRL instance via the linkbaseRef element. The xlink:href attribute contains the URL of the linkbase document being discovered. Every linkbase that is referenced by the linkbaseRef element MUST be discovered. 2. referenced from a discovered taxonomy schema via the linkbaseRef element. The xlink:href attribute contains the URL of the linkbase being discovered. Every linkbase that is referenced by the linkbaseRef element MUST be discovered. 3. that occur at the XPath "schema/annotation/appinfo/*" in a discovered taxonomy schema (Throughout this specification, schema, annotation and appinfo are all elements defined in the XML Schema namespace). 4. referenced from a discovered linkbase document via a loc element. Every linkbase that contains a resource that is referenced by an xlink:href attribute on a loc element in a discovered linkbase MUST be discovered.

Parameters:

parent -

discoverDocument

void discoverDocument(java.lang.String referringSchemaNamespaceUri,
                      java.lang.String parentURL,
                      TaxonomyDocument parent)

discoverLinkbase

void discoverLinkbase(java.lang.String parentUrl,
                      java.lang.String href,
                      LinkbaseDocument linkbaseDoc)

Discover the given linkbase document that was found through the given href which was located in the document found at the location of parentUrl.

Parameters:

parentUrl -

href -

linkbaseDoc -

validate

boolean validate()

Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessages collection.

Returns:

true if there ar no problems with this XbrlElementImpl

isValid

boolean isValid()

Return true when the DTS is valid

Returns:

boolean

setValid

void setValid(boolean valid)

Parameters:

valid - The valid to set.

validateInstance

boolean validateInstance(Xbrl xbrlElement,
                         ValidationDocument msgs)

validate xbrlElement with the content of the DTS.

completeInstance

void completeInstance(Xbrl xbrlElement)

complete xbrlElement with the content of the DTS for PTVI.

getLinkbases

java.util.Map getLinkbases()

Get the linkbases that are contained by this DTS mapped to their document href

Returns:

Map

addLinkbase

void addLinkbase(java.lang.String parentUrl,
                 java.lang.String URL,
                 LinkbaseContainer aPart)

Add the linkbaseContainer to this DTS. Determine its absolute location based on the URL relative to the parentUrl.

Parameters:

parentUrl -

URL -

aPart -

getGroup

Group getGroup(FullyQualifiedName qName)

getLinkBase

LinkbaseContainer getLinkBase(java.lang.String parentUrl,
                              java.lang.String URL)

get the LinkbaseContainer that was found at the URL location relative to the parentUrl.

Parameters:

parentUrl -

URL -

Returns:

LinkbaseContainer

removeLinkbase

void removeLinkbase(java.lang.String URI)

Remove the linkbase from this DTS that was found at the absolute location URI.

Parameters:

URI -

getTaxonomySchemas

java.util.Map getTaxonomySchemas()

Get the schemas that are contained by this DTS mapped to their document href

Returns:

Map

addTaxonomySchema

void addTaxonomySchema(java.lang.String parentUrl,
                       java.lang.String URL,
                       Root aPart)

Add the schema to this DTS. Determine its absolute location based on the URL relative to the parentUrl.

Parameters:

parentUrl -

URL -

aPart -

removeTaxonomySchema

void removeTaxonomySchema(java.lang.String URI)

Remove the schema from this DTS that was found at the absolute location URI.

Parameters:

URI -

getRoleType

RoleType getRoleType(java.lang.String uri)

get the roletype from this DTS that has the given uri

Parameters:

uri -

Returns:

RoleType

getMainTaxonomySchema

TaxonomySchema getMainTaxonomySchema()

Returns:

Returns the mainTaxonomySchema.

setMainTaxonomySchema

void setMainTaxonomySchema(TaxonomySchema mainTaxonomySchema)

Parameters:

mainTaxonomySchema - The mainTaxonomySchema to set.

getAllDiscoveredNetworks

java.util.Map getAllDiscoveredNetworks()

Returns:

Returns the discoveredNetworks.

getDiscoveredNetworks

java.util.List getDiscoveredNetworks(NetworkIndicator id)

Get the collection of discovered notworks in this DTS that can be identified by the given NetworkIndicator

Parameters:

id -

Returns:

List

getKnownTypes

java.util.Map getKnownTypes()

Returns:

Returns the knownTypes.

getKnownXbrlTypes

java.util.Map getKnownXbrlTypes()

Returns:

Returns the knownXbrlTypes.

getKnownConcepts

java.util.Map getKnownConcepts()

Returns:

Returns the knownConcepts.

getKnownItemTupleConcepts

java.util.Map getKnownItemTupleConcepts()

Returns:

Return the known concepts that are either in item or tuple substitution group

getKnownArcroleTypes

java.util.Map getKnownArcroleTypes()

Returns:

Returns the knownArcroleTypes.

putXSDatatypeByName

void putXSDatatypeByName(FullyQualifiedName qName,
                         com.sun.msv.datatype.xsd.XSDatatype wrappedXmlSchemaDatatype,
                         XbrlType wrappingXbrlConceptType)

Make sure the wrappingXbrlConceptType can be retreived for later use based on the name for the target namespace Make sure the wrappedXmlSchemaDatatype can be retreived for later use based on the given qName. Make sure the wrappingXbrlConceptType can be retreived for later use based on the given wrappedXmlSchemaDatatype

Parameters:

qName -

wrappedXmlSchemaDatatype -

wrappingXbrlConceptType -

findWrapper

XbrlType findWrapper(com.sun.msv.datatype.xsd.XSDatatype wrappedXmlSchemaDatatype)

Get the XbrlConceptType that uses the given XSDatatype

Parameters:

wrappedXmlSchemaDatatype -

Returns:

XbrlConceptType

getXSDatatypeByName

com.sun.msv.datatype.xsd.XSDatatype getXSDatatypeByName(java.lang.String name,
                                                        XmlParticle parent)

Get the XSDatatype that has the given name. Use the parent to create a qName.

Parameters:

name -

parent -

Returns:

XSDatatype

getNetworks

java.util.Map getNetworks()

Returns:

Returns the networks.

getNetworkBaseSets

java.util.Map getNetworkBaseSets()

Returns:

Returns the networkBaseSets.

getIndicators

java.util.Map getIndicators()

Returns:

Returns the indicators.

getKnownRoleTypes

java.util.Map getKnownRoleTypes()

Returns:

Returns the knownRoleTypes.

isXbrlInstanceSchemaImported

boolean isXbrlInstanceSchemaImported()

Returns:

Returns the xbrlInstanceSchemaImported.

setXbrlInstanceSchemaImported

void setXbrlInstanceSchemaImported(boolean xbrlInstanceSchemaImported)

Parameters:

xbrlInstanceSchemaImported - The xbrlInstanceSchemaImported to set.

getKnownConceptsInTupleConceptsQnames

Set getKnownConceptsInTupleConceptsQnames()

Returns:

Returns the knownConceptsInTupleConcepts.

setKnownConceptsInTupleConcepts

void setKnownConceptsInTupleConcepts(Set knownConceptsInTupleConcepts)

Parameters:

knownConceptsInTupleConcepts - The knownConceptsInTupleConcepts to set.

getXSDatatypes

java.util.Map getXSDatatypes()

Returns:

Returns the xSDatatypes.

setXSDatatypes

void setXSDatatypes(java.util.Map datatypes)

Parameters:

datatypes - The xSDatatypes to set.

getXSDatatypesToConceptTypes

java.util.Map getXSDatatypesToConceptTypes()

Returns:

Returns the xSDatatypesToConceptTypes.

setXSDatatypesToConceptTypes

void setXSDatatypesToConceptTypes(java.util.Map datatypesToConceptTypes)

Parameters:

datatypesToConceptTypes - The xSDatatypesToConceptTypes to set.

getSupportedLanguageCodes

java.util.List getSupportedLanguageCodes()

findNetworks

java.util.List findNetworks(java.lang.String arcLocalName,
                            java.lang.String arcNamespace,
                            java.lang.String arcRole,
                            java.lang.String linkLocalName,
                            java.lang.String linkNamespace,
                            java.lang.String linkRole)

Find the networks constructed with the given arguments, arc local name and namespace, arcRole, link local name and namespace, linkRole. Ignores null arguments. return a list with the found networks

Parameters:

arcLocalName - String, local name of arc element used to construct searched networks , may be null

arcNamespace - String, namespace uri of name of arc element used to construct searched networks , may be null

arcRole - String, role uri of arcrole on arc element used to construct searched networks, may be null

linkLocalName - String, local name of link element used to construct searched networks , may be null

linkNamespace - String, namespace uri of name of link element used to construct searched networks , may be null

linkRole - String, role uri of linkrole of link element used to construct searched networks, may be null

Returns:

List with the found networks

findNetworksUsingConcept

java.util.List findNetworksUsingConcept(Concept concept,
                                        java.lang.String linkLocalName)

Find the networks in which the given concept is used for the given link local name. return a list with the found networks

Parameters:

concept - Concept, may not be null

linkLocalName - String, local name of link element used to construct searched networks , may be null

Returns:

List with the found networks

findNetworksUsingConcept

java.util.List findNetworksUsingConcept(Concept concept,
                                        java.lang.String arcLocalName,
                                        java.lang.String arcNamespace,
                                        java.lang.String arcRole,
                                        java.lang.String linkLocalName,
                                        java.lang.String linkNamespace,
                                        java.lang.String linkRole)

Find the networks in which the given concept is used for the given arguments, arc local name and namespace, arcRole, link local name and namespace, linkRole. Ignores null arguments. return a list with the found networks

Parameters:

concept - Concept, may not be null

arcLocalName - String, local name of arc element used to construct searched networks , may be null

arcNamespace - String, namespace uri of name of arc element used to construct searched networks , may be null

arcRole - String, role uri of arcrole on arc element used to construct searched networks, may be null

linkLocalName - String, local name of link element used to construct searched networks , may be null

linkNamespace - String, namespace uri of name of link element used to construct searched networks , may be null

linkRole - String, role uri of linkrole of link element used to construct searched networks, may be null

Returns:

List with the found networks

findRolesUsingConcept

java.util.List findRolesUsingConcept(Concept concept,
                                     java.lang.String linkLocalName)

Find the role uris in whose networks the given concept is used for the given link local name. return a list with the found uris

Parameters:

concept - Concept, may not be null

linkLocalName - String, local name of link element used to construct searched networks , may be null

Returns:

List with the found networks

findNetworksWithFilters

java.util.List findNetworksWithFilters(java.lang.String arcLocalName,
                                       java.lang.String arcNamespace,
                                       java.lang.String arcRole,
                                       java.lang.String linkLocalName,
                                       java.lang.String linkNamespace,
                                       java.lang.String linkRole,
                                       java.util.List requiredExtendedLinkSubRoleUris)

Find the networks constructed with the given arguments, arc local name and namespace, arcRole, link local name and namespace, linkRole and filters with sub uris. Ignores null arguments. return a list with the found networks

Parameters:

arcLocalName - String, local name of arc element used to construct searched networks , may be null

arcNamespace - String, namespace uri of name of arc element used to construct searched networks , may be null

arcRole - String, role uri of arcrole on arc element used to construct searched networks, may be null

linkLocalName - String, local name of link element used to construct searched networks , may be null

linkNamespace - String, namespace uri of name of link element used to construct searched networks , may be null

linkRole - String, role uri of linkrole of link element used to construct searched networks, may be null

requiredExtendedLinkSubRoleUris - List with sub uris on which the extended link roles must be filtered., may not be null

Returns:

List with the found networks

findNetworksUsingConceptWithFilters

java.util.List findNetworksUsingConceptWithFilters(Concept concept,
                                                   java.lang.String linkLocalName,
                                                   java.util.List requiredExtendedLinkSubRoleUris)

Find the networks in which the given concept is used for the given link local name and filters with sub uris. return a list with the found networks

Parameters:

concept - Concept, may not be null

linkLocalName - String, local name of link element used to construct searched networks , may be null

requiredExtendedLinkSubRoleUris - List with sub uris on which the extended link roles must be filtered., may not be null

Returns:

List with the found networks

findNetworksUsingConceptWithFilters

java.util.List findNetworksUsingConceptWithFilters(Concept concept,
                                                   java.lang.String arcLocalName,
                                                   java.lang.String arcNamespace,
                                                   java.lang.String arcRole,
                                                   java.lang.String linkLocalName,
                                                   java.lang.String linkNamespace,
                                                   java.lang.String linkRole,
                                                   java.util.List requiredExtendedLinkSubRoleUris)

Find the networks in which the given concept is used for the given arguments, arc local name and namespace, arcRole, link local name and namespace, linkRole and filters with sub uris. Ignores null arguments. return a list with the found networks

Parameters:

concept - Concept, may not be null

arcLocalName - String, local name of arc element used to construct searched networks , may be null

arcNamespace - String, namespace uri of name of arc element used to construct searched networks , may be null

arcRole - String, role uri of arcrole on arc element used to construct searched networks, may be null

linkLocalName - String, local name of link element used to construct searched networks , may be null

linkNamespace - String, namespace uri of name of link element used to construct searched networks , may be null

linkRole - String, role uri of linkrole of link element used to construct searched networks, may be null

requiredExtendedLinkSubRoleUris - List with sub uris on which the extended link roles must be filtered., may not be null

Returns:

List with the found networks

findRolesUsingConceptWithFilters

java.util.List findRolesUsingConceptWithFilters(Concept concept,
                                                java.lang.String linkLocalName,
                                                java.util.List requiredExtendedLinkSubRoleUris)

Find the role uris in whose networks the given concept is used for the given link local name and filters with sub uris. return a list with the found uris

Parameters:

concept - Concept, may not be null

linkLocalName - String, local name of link element used to construct searched networks , may be null

requiredExtendedLinkSubRoleUris - List with sub uris on which the extended link roles must be filtered., may not be null

Returns:

List with the found networks

findNetworksWithFilters

java.util.List findNetworksWithFilters(java.lang.String linkLocalName,
                                       java.util.List requiredExtendedLinkSubRoleUris)

findNetworks

java.util.List findNetworks(java.lang.String linkLocalName)

getDeclaration

Declaration getDeclaration(FullyQualifiedName qName)

getKnownDeclarations

java.util.Map getKnownDeclarations()

getKnownAttributeGroups

java.util.Map getKnownAttributeGroups()

Returns:

Returns the knownAttributeGroups.

getKnownAttributes

java.util.Map getKnownAttributes()

Returns:

Returns the knownAttributes.

getSubstitutions

java.util.Map getSubstitutions()

Returns:

Returns the substitutions.

getKnownGroups

java.util.Map getKnownGroups()

findNetworksFromTo

java.util.List findNetworksFromTo(IdHolder source,
                                  IdHolder target,
                                  java.lang.String arcLocalName,
                                  java.lang.String arcNamespace,
                                  java.lang.String arcRole,
                                  java.lang.String linkLocalName,
                                  java.lang.String linkNamespace,
                                  java.lang.String linkRole)

getArcRoleType

ArcroleType getArcRoleType(java.lang.String uri)

addBaseDTS

void addBaseDTS(DiscoverableTaxonomySet baseDTS,
                java.lang.String urlMainSchema)

clear

void clear()

getDtsUrls

java.util.List getDtsUrls()

getOrderedRoles

java.util.List getOrderedRoles()