org.xbrlapi
Interface Schema

All Superinterfaces:

Comparable<XML>, Fragment, SchemaContent, Serializable, XML

All Known Implementing Classes:

SchemaImpl

public interface Schema
extends SchemaContent

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

List<ArcroleType>	getArcroleTypes()
Concept	getConceptByName(String name) Get a specific concept by its name.
long	getConceptCount() Get the number of concepts defined in the schema.
List<Concept>	getConcepts() Get the fragment list of concepts in the schema.
List<Concept>	getConceptsBySubstitutionGroup(URI namespace, String localname) Get a list concepts based on their substitution group.
List<Concept>	getConceptsByType(URI namespace, String localName) Get a list of concepts based on their type.
List<ExtendedLink>	getExtendedLinks()
List<ComplexTypeDeclaration>	getGlobalComplexTypes()
<D extends SchemaDeclaration> D	getGlobalDeclaration(String name)
List<SimpleTypeDeclaration>	getGlobalSimpleTypes()
List<Schema>	getImporters()
List<SimpleLink>	getImports()
List<SimpleLink>	getIncludes()
List<Concept>	getOtherElementDeclarations() Get the fragment list of element declarations (that are not concepts) in the schema.
ReferencePartDeclaration	getReferencePartDeclaration(String name) Get a reference part declaration in a schema.
List<ReferencePartDeclaration>	getReferencePartDeclarations() Get a list of the reference part declarations in a schema.
List<RoleType>	getRoleTypes()
boolean	isElementFormQualified() Checks if the element form is qualified.

Methods inherited from interface org.xbrlapi.SchemaContent

getAnnotations, getOtherAttribute, getOtherAttributes, getSchema, getSchemaId, getTargetNamespace, hasOtherAttribute

Methods inherited from interface org.xbrlapi.Fragment

appendElementSchemeXPointer, appendID, getAllChildren, getAllChildrenIndices, getAncestorOrSelf, getChild, getChildren, getChildren, getChildrenIndices, getDataRootElement, getElementSchemeXPointerExpression, getIDXPointerExpression, getLabels, getLabels, getLabels, getLabelsWithLanguage, getLabelsWithLanguageAndResourceRole, getLabelsWithLanguageAndResourceRoleAndLinkRole, getLabelsWithResourceRole, getLanguage, getLanguage, getLanguageName, getLanguageName, getLocalname, getLocalnameFromQName, getNamespace, getNamespaceFromQName, getParent, getParentElement, getParentIndex, getPrefixFromQName, getReferences, getReferencesWithLanguage, getReferencesWithLanguageAndResourceRoleAndLinkRole, getReferencesWithLanguageAndRole, getReferencesWithResourceRole, getReferencingLocators, getSequenceToParentElement, getSequenceToParentElementAsString, getSimpleLinks, getURI, getXPath, getXPointerExpression, isAncestorOf, isChild, isNewFragment, isRoot, setParentIndex, setSequenceToParentElement, setURI

Methods inherited from interface org.xbrlapi.XML

appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isElementFormQualified

boolean isElementFormQualified()
                               throws XBRLException

Checks if the element form is qualified.

Returns:

true if the element form is qualified and false otherwise.

Throws:

XBRLException

getImports

List<SimpleLink> getImports()
                            throws XBRLException

Returns:

a list of SimpleLink fragments, one per XML Schema import used by this schema.

Throws:

XBRLException

getImporters

List<Schema> getImporters()
                          throws XBRLException

Returns:

the list of schemas that import this schema.

Throws:

XBRLException

getIncludes

List<SimpleLink> getIncludes()
                             throws XBRLException

Returns:

a list of SimpleLink fragments, one per XML Schema include used by this schema.

Throws:

XBRLException

getExtendedLinks

List<ExtendedLink> getExtendedLinks()
                                    throws XBRLException

Returns:

a list of the extended links contained by the schema.

Throws:

XBRLException

getOtherElementDeclarations

List<Concept> getOtherElementDeclarations()
                                          throws XBRLException

Get the fragment list of element declarations (that are not concepts) in the schema.

Returns:

the list of element declarations in the schema.

Throws:

XBRLException.

XBRLException

getConcepts

List<Concept> getConcepts()
                          throws XBRLException

Get the fragment list of concepts in the schema.

Returns:

the list of concepts in the schema.

Throws:

XBRLException.

XBRLException

getConceptCount

long getConceptCount()
                     throws XBRLException

Get the number of concepts defined in the schema.

Returns:

the number of XBRL concepts defined in the schema. Note that concepts that are overloaded with and XBRL Dimensions interpretation are excluded from this count if the XBRL Dimensions loader is being used.

Throws:

XBRLException.

XBRLException

getConceptByName

Concept getConceptByName(String name)
                         throws XBRLException

Get a specific concept by its name. return the chosen concept or null if the concept does not exist.

Parameters:

name - The name of the concept

Throws:

XBRLException

getConceptsByType

List<Concept> getConceptsByType(URI namespace,
                                String localName)
                                throws XBRLException

Get a list of concepts based on their type. Returns null if no concepts match the selection criteria.

Parameters:

namespace - The namespaceURI of the concept type

localName - The local name of the concept type

Returns:

A list of concept fragments in the containing schema that match the specified element type.

Throws:

XBRLException

getConceptsBySubstitutionGroup

List<Concept> getConceptsBySubstitutionGroup(URI namespace,
                                             String localname)
                                             throws XBRLException

Get a list concepts based on their substitution group. Returns null if no concepts match the selection criteria.

Parameters:

namespace - The namespaceURI of the concept type

localname - The local name of the concept type

Returns:

a list of concepts in the schema that match the specified substitution group

Throws:

XBRLException

getReferencePartDeclaration

ReferencePartDeclaration getReferencePartDeclaration(String name)
                                                     throws XBRLException

Get a reference part declaration in a schema. Returns null if the reference part does not exist in the schema.

Parameters:

name - The name attribute value of the reference part to be retrieved.

Throws:

XBRLException

getReferencePartDeclarations

List<ReferencePartDeclaration> getReferencePartDeclarations()
                                                            throws XBRLException

Get a list of the reference part declarations in a schema.

Returns:

a list of reference part declarations in the schema.

Throws:

XBRLException

getRoleTypes

List<RoleType> getRoleTypes()
                            throws XBRLException

Returns:

the list of role type definitions in the schema

Throws:

XBRLException

getArcroleTypes

List<ArcroleType> getArcroleTypes()
                                  throws XBRLException

Returns:

the list of arcrole type definitions in the schema

Throws:

XBRLException

getGlobalComplexTypes

List<ComplexTypeDeclaration> getGlobalComplexTypes()
                                                   throws XBRLException

Returns:

the list of global complex type declarations in this schema.

Throws:

XBRLException

getGlobalSimpleTypes

List<SimpleTypeDeclaration> getGlobalSimpleTypes()
                                                 throws XBRLException

Returns:

the list of global simple type declarations in this schema.

Throws:

XBRLException

getGlobalDeclaration

<D extends SchemaDeclaration> D getGlobalDeclaration(String name)
                                                 throws XBRLException

Type Parameters:

D - The type of the declaration being retrieved.

Parameters:

name - The name of the declaration being retrieved.

Returns:

the fragment representing the global schema declaration or null if none exists.

Throws:

XBRLException - if the name is null or if the specified type of the global declaration is not consistent with the actual type of the declaration.