org.xbrlapi.impl

Class SchemaDeclarationImpl

java.lang.Object

org.xbrlapi.impl.XMLImpl

org.xbrlapi.impl.FragmentImpl

org.xbrlapi.impl.SchemaContentImpl

org.xbrlapi.impl.SchemaDeclarationImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<XML>, Fragment, SchemaContent, SchemaDeclaration, XML

Direct Known Subclasses:

AttributeGroupDeclarationImpl, SchemaContentDeclarationImpl, TypeDeclarationImpl

public class SchemaDeclarationImpl
extends SchemaContentImpl
implements SchemaDeclaration

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SchemaDeclarationImpl()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Get the name of structure being declared.
<F extends SchemaDeclaration> F	getReferencedSchemaDeclaration()
java.lang.String	getReferenceLocalname() Retrieve the type local name.
java.lang.String	getReferenceNamespace()
java.lang.String	getReferenceNamespaceAlias()
java.lang.String	getReferenceQName()
boolean	hasReference()

Methods inherited from class org.xbrlapi.impl.SchemaContentImpl

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

Methods inherited from class org.xbrlapi.impl.FragmentImpl

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 class org.xbrlapi.impl.XMLImpl

appendMetadataElement, compareTo, 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 class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

SchemaDeclarationImpl

public SchemaDeclarationImpl()

Method Detail

getName

public java.lang.String getName()
                         throws XBRLException

Get the name of structure being declared.

Specified by:

getName in interface SchemaDeclaration

Returns:

the name of the structure being declared.

Throws:

XBRLException

See Also:

SchemaDeclaration.getName()

hasReference

public boolean hasReference()
                     throws XBRLException

Specified by:

hasReference in interface SchemaDeclaration

Returns:

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

Throws:

XBRLException

See Also:

SchemaDeclaration.hasReference()

getReferenceNamespace

public java.lang.String getReferenceNamespace()
                                       throws XBRLException

Specified by:

getReferenceNamespace in interface SchemaDeclaration

Returns:

the namespace for the referenced XML Schema declaration.

Throws:

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

See Also:

SchemaDeclaration.getReferenceNamespace()

getReferenceNamespaceAlias

public java.lang.String getReferenceNamespaceAlias()
                                            throws XBRLException

Specified by:

getReferenceNamespaceAlias in interface SchemaDeclaration

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

See Also:

SchemaDeclaration.getReferenceNamespaceAlias()

getReferenceQName

public java.lang.String getReferenceQName()
                                   throws XBRLException

Specified by:

getReferenceQName in interface SchemaDeclaration

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.

See Also:

SchemaDeclaration.getReferenceQName()

getReferenceLocalname

public java.lang.String getReferenceLocalname()
                                       throws XBRLException

Description copied from interface: SchemaDeclaration

Retrieve the type local name.

Specified by:

getReferenceLocalname in interface SchemaDeclaration

Returns:

the local name for the datatype.

Throws:

XBRLException - if the datatype is not declared.

See Also:

SchemaDeclaration.getReferenceLocalname()

getReferencedSchemaDeclaration

public <F extends SchemaDeclaration> F getReferencedSchemaDeclaration()
                                                           throws XBRLException

Specified by:

getReferencedSchemaDeclaration in interface SchemaDeclaration

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.

See Also:

SchemaDeclaration.getReferencedSchemaDeclaration()