org.xbrlapi
Interface SchemaDeclaration

All Superinterfaces:

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

All Known Subinterfaces:

AttributeDeclaration, AttributeGroupDeclaration, ComplexTypeDeclaration, Concept, Dimension, ElementDeclaration, ExplicitDimension, Hypercube, ReferencePartDeclaration, SchemaContentDeclaration, SimpleTypeDeclaration, TypedDimension, TypeDeclaration, XDTConcept

All Known Implementing Classes:

AttributeDeclarationImpl, AttributeGroupDeclarationImpl, ComplexTypeDeclarationImpl, ConceptImpl, DimensionImpl, ElementDeclarationImpl, ExplicitDimensionImpl, HypercubeImpl, ReferencePartDeclarationImpl, SchemaContentDeclarationImpl, SchemaDeclarationImpl, SimpleTypeDeclarationImpl, TypedDimensionImpl, TypeDeclarationImpl, XDTConceptImpl

public interface SchemaDeclaration
extends SchemaContent

Base interface for all kinds of XML Schema declarations

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

String	getName()
<F extends SchemaDeclaration> F	getReferencedSchemaDeclaration()
String	getReferenceLocalname() Retrieve the type local name.
URI	getReferenceNamespace()
String	getReferenceNamespaceAlias()
String	getReferenceQName()
boolean	hasReference()

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

getName

String getName()
               throws XBRLException

Returns:

the name of the structure being declared or null of the structure has no name.

Throws:

XBRLException

hasReference

boolean hasReference()
                     throws XBRLException

Returns:

true if the content declaration uses a reference to another XML Schema declaration and false otherwise.

Throws:

XBRLException

getReferenceNamespace

URI getReferenceNamespace()
                          throws XBRLException

Returns:

the namespace for the referenced XML Schema declaration.

Throws:

XBRLException - if the datatype is not declared by a type attribute.

getReferenceNamespaceAlias

String getReferenceNamespaceAlias()
                                  throws XBRLException

Returns:

the namespace alias (prefix) for the referenced XML Schema declaration or the empty string if there is no namespace prefix used in the QName.

Throws:

XBRLException

getReferenceQName

String getReferenceQName()
                         throws XBRLException

Returns:

the QName used to specify the identity of the referenced XML Schema declaration.

Throws:

XBRLException - if the content declaration does not reference another XML Schema content declaration using a ref attribute.

getReferenceLocalname

String getReferenceLocalname()
                             throws XBRLException

Retrieve the type local name.

Returns:

the local name for the datatype.

Throws:

XBRLException - if the datatype is not declared.

getReferencedSchemaDeclaration

<F extends SchemaDeclaration> F getReferencedSchemaDeclaration()
                                                           throws XBRLException

Returns:

The fragment that is the XML Schema declaration referred to by the schema content declaration.

Throws:

XBRLException - if the fragment cannot be found in the data store.