org.xbrlapi
Interface SchemaContentDeclaration

All Superinterfaces:

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

All Known Subinterfaces:

AttributeDeclaration, Concept, Dimension, ElementDeclaration, ExplicitDimension, Hypercube, ReferencePartDeclaration, TypedDimension, XDTConcept

All Known Implementing Classes:

AttributeDeclarationImpl, ConceptImpl, DimensionImpl, ElementDeclarationImpl, ExplicitDimensionImpl, HypercubeImpl, ReferencePartDeclarationImpl, SchemaContentDeclarationImpl, TypedDimensionImpl, XDTConceptImpl

public interface SchemaContentDeclaration
extends SchemaDeclaration

Base interface for XML Schema element and attribute declarations

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

String	getDefault()
String	getFixed()
String	getForm()
TypeDeclaration	getLocalType()
TypeDeclaration	getTypeDeclaration()
String	getTypeLocalname() Retrieve the type local name.
URI	getTypeNamespace() Retrieve the type namespace.
String	getTypeNamespaceAlias() Retrieve the type namespace alias.
String	getTypeQName() Retrieve the type QName.
boolean	hasLocalType()
boolean	hasTypeReference()
boolean	isFixed()
boolean	isGlobal()

Methods inherited from interface org.xbrlapi.SchemaDeclaration

getName, getReferencedSchemaDeclaration, getReferenceLocalname, getReferenceNamespace, getReferenceNamespaceAlias, getReferenceQName, 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

isGlobal

boolean isGlobal()
                 throws XBRLException

Returns:

true iff the element declaration is global rather than part of a complex type declaration.

Throws:

XBRLException

getForm

String getForm()
               throws XBRLException

Returns:

the value of the form attribute if it is on the attribute declaration and returns null otherwise.

Throws:

XBRLException

getDefault

String getDefault()
                  throws XBRLException

Returns:

null if there is no default attribute, otherwise return its value.

Throws:

XBRLException

getFixed

String getFixed()
                throws XBRLException

Returns:

null if there is no fixed attribute, otherwise return its value.

Throws:

XBRLException

isFixed

boolean isFixed()
                throws XBRLException

Returns:

true iff the element or attribute is fixed and false otherwise.

Throws:

XBRLException

hasTypeReference

boolean hasTypeReference()
                         throws XBRLException

Returns:

true if the content declaration has a named data type and false otherwise.

Throws:

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

getTypeNamespace

URI getTypeNamespace()
                     throws XBRLException

Retrieve the type namespace.

Returns:

the namespace for the data type.

Throws:

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

getTypeNamespaceAlias

String getTypeNamespaceAlias()
                             throws XBRLException

Retrieve the type namespace alias.

Returns:

the namespace alias (prefix) or the empty string if there is no namespace prefix used in the QName.

Throws:

XBRLException - if the datatype is not declared.

getTypeQName

String getTypeQName()
                    throws XBRLException

Retrieve the type QName.

Returns:

the QName used to specify the data type or null if the element has no type attribute.

Throws:

XBRLException - if the data root element is not available.

getTypeLocalname

String getTypeLocalname()
                        throws XBRLException

Retrieve the type local name.

Returns:

the local name for the datatype.

Throws:

XBRLException - if the datatype is not declared.

getTypeDeclaration

TypeDeclaration getTypeDeclaration()
                                   throws XBRLException

Returns:

The fragment that is the type declaration referred to by the schema content declaration or null if there is no type declaration.

Throws:

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

hasLocalType

boolean hasLocalType()
                     throws XBRLException

Returns:

true iff the content declaration has its own local simple or complex type declaration.

Throws:

XBRLException - if the content declaration has more than one local type declaration.

getLocalType

TypeDeclaration getLocalType()
                             throws XBRLException

Returns:

The local type declaration or null if the content declaration does not have its own local type declaration.

Throws:

XBRLException