org.xbrlapi
Interface ElementDeclaration

All Superinterfaces:

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

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface ElementDeclaration
extends SchemaContentDeclaration

Used for top level element declarations (where the elements are given a name and occur as children of XML Schema schema elements. Other element declarations are not used as roots for fragments.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

ComplexTypeDeclaration	getLocalComplexType()
String	getMaxOccurs()
String	getMinOccurs()
ElementDeclaration	getSubstitutionGroupDeclaration()
String	getSubstitutionGroupLocalname() Retrieve the substitution group local name.
URI	getSubstitutionGroupNamespace() Retrieve the substitution group namespace.
String	getSubstitutionGroupNamespaceAlias() Retrieve the substitution group namespace alias (also known as a namespace prefix).
String	getSubstitutionGroupQName() Retrieve the substitution group QName.
boolean	hasLocalComplexType()
boolean	hasSubstitutionGroup()
boolean	isAbstract()
boolean	isBlockingExtension()
boolean	isBlockingRestriction()
boolean	isBlockingSubstitution()
boolean	isFinalForExtension()
boolean	isFinalForRestriction()
boolean	isItem()
boolean	isNillable() Determine if a concept is nillable
boolean	isTuple()

Methods inherited from interface org.xbrlapi.SchemaContentDeclaration

getDefault, getFixed, getForm, getLocalType, getTypeDeclaration, getTypeLocalname, getTypeNamespace, getTypeNamespaceAlias, getTypeQName, hasLocalType, hasTypeReference, isFixed, 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, getLabelsWithLanguage, getLabelsWithLanguageAndResourceRole, getLabelsWithLanguageAndResourceRoleAndLinkRole, getLabelsWithResourceRole, 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, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isAbstract

boolean isAbstract()
                   throws XBRLException

Returns:

true if the element is abstract and false otherwise.

Throws:

XBRLException

isFinalForExtension

boolean isFinalForExtension()
                            throws XBRLException

Returns:

true iff the element is final for extension.

Throws:

XBRLException

isFinalForRestriction

boolean isFinalForRestriction()
                              throws XBRLException

Returns:

true iff the element is final for restriction.

Throws:

XBRLException

isBlockingSubstitution

boolean isBlockingSubstitution()
                               throws XBRLException

Returns:

true iff the element is blocking substitution.

Throws:

XBRLException

isBlockingExtension

boolean isBlockingExtension()
                            throws XBRLException

Returns:

true iff the element is blocking extension.

Throws:

XBRLException

isBlockingRestriction

boolean isBlockingRestriction()
                              throws XBRLException

Returns:

true iff the element is blocking restriction.

Throws:

XBRLException

isNillable

boolean isNillable()
                   throws XBRLException

Determine if a concept is nillable

Returns:

true if the concept is nillable and false otherwise.

Throws:

XBRLException

hasSubstitutionGroup

boolean hasSubstitutionGroup()
                             throws XBRLException

Returns:

true if the content declaration has a named substitution group and false otherwise.

Throws:

XBRLException

getSubstitutionGroupDeclaration

ElementDeclaration getSubstitutionGroupDeclaration()
                                                   throws XBRLException

Returns:

The fragment that is the declaration of the substitution group element.

Throws:

XBRLException - if there is no such declaration in the data store or if the fragment is not an XML Schema element declaration.

getSubstitutionGroupNamespace

URI getSubstitutionGroupNamespace()
                                  throws XBRLException

Retrieve the substitution group namespace.

Returns:

the namespace for the element substitution group.

Throws:

XBRLException - if the substitution group is not declared by a substitution group attribute.

getSubstitutionGroupNamespaceAlias

String getSubstitutionGroupNamespaceAlias()
                                          throws XBRLException

Retrieve the substitution group namespace alias (also known as a namespace prefix).

Returns:

the namespace alias for the element substitution group or the empty string if the default namespace prefix is used.

Throws:

XBRLException - if the substitution group is not declared by a substitution group attribute.

getSubstitutionGroupQName

String getSubstitutionGroupQName()
                                 throws XBRLException

Retrieve the substitution group QName.

Returns:

the QName used to specify the substitution group or null if the element has no substitutionGroup attribute.

Throws:

XBRLException - if the data root element is not available.

getSubstitutionGroupLocalname

String getSubstitutionGroupLocalname()
                                     throws XBRLException

Retrieve the substitution group local name.

Returns:

the local name for the substitution group.

Throws:

XBRLException - if the substitution group is not declared.

isItem

boolean isItem()
               throws XBRLException

Returns:

true if the element declaration is for an element in the substitution group for the XBRL item element and false otherwise.

Throws:

XBRLException

isTuple

boolean isTuple()
                throws XBRLException

Returns:

true if the element declaration is for an element in the substitution group for the XBRL tuple element and false otherwise.

Throws:

XBRLException

hasLocalComplexType

boolean hasLocalComplexType()
                            throws XBRLException

Returns:

true iff the element declaration has a single local complex type.

Throws:

XBRLException

getLocalComplexType

ComplexTypeDeclaration getLocalComplexType()
                                           throws XBRLException

Returns:

the local complex type definition.

Throws:

XBRLException - if there is no local complex type declaration or if there is more than one local complex type declaration (an XML Schema error).

getMaxOccurs

String getMaxOccurs()
                    throws XBRLException

Returns:

the maximum number of times that the element can occur within a complex type definition.

Throws:

XBRLException - if the element declaration is global.

getMinOccurs

String getMinOccurs()
                    throws XBRLException

Returns:

the minimum number of times that the element can occur within a complex type definition.

Throws:

XBRLException - if the element declaration is global.