tqa/eu.cdevreeze.tqa.base.model.queryapi/TaxonomySchemaApi

TaxonomySchemaApi

trait TaxonomySchemaApi extends SchemaApi

Purely abstract trait offering a dimensionally-aware XBRL taxonomy schema API.

Purely abstract trait offering a dimensionally-aware XBRL taxonomy schema API.

See super-type SchemaApi for more information.

Primary item declarations are concept declarations that are neither hypercubes nor dimensions, regardless of whether they are used as primary items or domain members!

This API is also aware of enumeration (2.0) concepts. Recognition of enumeration concepts may fail, however, if the item concept has an anonymous type nested in the global element declaration.

Authors

Chris de Vreeze

trait SchemaApi
class Object
trait Matchable
class Any

Value members

Abstract methods

def filterItemDeclarations(p: ItemDeclaration => Boolean): IndexedSeq[ItemDeclaration]
def findConceptDeclaration(ename: EName): Option[ConceptDeclaration]
def findItemDeclaration(ename: EName): Option[ItemDeclaration]
def findTupleDeclaration(ename: EName): Option[TupleDeclaration]
def isEnumerationConcept(ename: EName): Boolean
def isEnumerationConcept(itemDecl: ItemDeclaration): Boolean
def isEnumerationItemType(ename: EName): Boolean
def isSetValueEnumerationConcept(ename: EName): Boolean
def isSetValueEnumerationItemType(ename: EName): Boolean
def isSingleValueEnumerationConcept(ename: EName): Boolean
def isSingleValueEnumerationItemType(ename: EName): Boolean

Inherited methods

def filterNamedTypeDefinitions(p: NamedTypeDefinition => Boolean): IndexedSeq[NamedTypeDefinition]
Inherited from
SchemaApi
def findBaseTypeOrSelfUntil(typeEName: EName, p: EName => Boolean): Option[EName]

If the given type obeys the type predicate, returns it, wrapped in an Option. Otherwise, returns the optional base type if that type obeys the type predicate, and so on, until either the predicate holds or no further base type can be found in the taxonomy.

If the given type obeys the type predicate, returns it, wrapped in an Option. Otherwise, returns the optional base type if that type obeys the type predicate, and so on, until either the predicate holds or no further base type can be found in the taxonomy.

Inherited from
SchemaApi
def findGlobalElementDeclaration(ename: EName): Option[GlobalElementDeclaration]
Inherited from
SchemaApi
def findGlobalElementDeclarationById(id: String): Option[GlobalElementDeclaration]

Finds the optional global element declaration having the given ID, assuming that at most one result matches.

Finds the optional global element declaration having the given ID, assuming that at most one result matches.

Inherited from
SchemaApi
def findNamedSimpleTypeDefinition(ename: EName): Option[NamedSimpleTypeDefinition]
Inherited from
SchemaApi
def findNamedTypeDefinition(ename: EName): Option[NamedTypeDefinition]
Inherited from
SchemaApi
def findNamedTypeOfGlobalElementDeclaration(ename: EName): Option[EName]

Finds the named type of the global element declaration with the given target EName, recursively trying to obtain the type via the substitution group ancestry chain, if needed.

Finds the named type of the global element declaration with the given target EName, recursively trying to obtain the type via the substitution group ancestry chain, if needed.

Inherited from
SchemaApi
def getGlobalElementDeclarationById(id: String): GlobalElementDeclaration

Gets the global element declaration having the given ID, assuming that at precisely one result matches.

Gets the global element declaration having the given ID, assuming that at precisely one result matches.

Inherited from
SchemaApi
def getNamedTypeDefinition(ename: EName): NamedTypeDefinition
Inherited from
SchemaApi
def substitutionGroupMap: SubstitutionGroupMap

Returns the known substitution groups as SubstitutionGroupMap. If the taxonomy is closed under DTS discovery, these substitution groups are found within the taxonomy. Otherwise they may partly be external.

Returns the known substitution groups as SubstitutionGroupMap. If the taxonomy is closed under DTS discovery, these substitution groups are found within the taxonomy. Otherwise they may partly be external.

Implementations should store this as a field, in order to make substitution group lookups as fast as possible.

Inherited from
SchemaApi