org.xbrlapi
Interface SchemaContent

All Superinterfaces:

Comparable<XML>, Fragment, Serializable, XML

All Known Subinterfaces:

AttributeDeclaration, AttributeGroupDeclaration, ComplexTypeDeclaration, Concept, Dimension, ElementDeclaration, ExplicitDimension, Hypercube, ReferencePartDeclaration, Schema, SchemaAllCompositor, SchemaChoiceCompositor, SchemaCompositor, SchemaContentDeclaration, SchemaDeclaration, SchemaGroupCompositor, SchemaSequenceCompositor, SimpleTypeDeclaration, TypedDimension, TypeDeclaration, XDTConcept

All Known Implementing Classes:

AttributeDeclarationImpl, AttributeGroupDeclarationImpl, ComplexTypeDeclarationImpl, ConceptImpl, DimensionImpl, ElementDeclarationImpl, ExplicitDimensionImpl, HypercubeImpl, ReferencePartDeclarationImpl, SchemaAllCompositorImpl, SchemaChoiceCompositorImpl, SchemaCompositorImpl, SchemaContentDeclarationImpl, SchemaContentImpl, SchemaDeclarationImpl, SchemaGroupCompositorImpl, SchemaImpl, SchemaSequenceCompositorImpl, SimpleTypeDeclarationImpl, TypedDimensionImpl, TypeDeclarationImpl, XDTConceptImpl

public interface SchemaContent
extends Fragment

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

List<Element>	getAnnotations()
String	getOtherAttribute(URI namespace, String localname) Mirrors the getAttributeNS method of the org.w3c.dom.Element class.
List<Node>	getOtherAttributes()
Schema	getSchema()
String	getSchemaId()
URI	getTargetNamespace()
boolean	hasOtherAttribute(URI namespace, String localname) Mirrors the hasAttributeNS method of the org.w3c.dom.Element class.

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

getSchema

Schema getSchema()
                 throws XBRLException

Returns:

the schema fragment that is the schema containing this element declaration.

Throws:

XBRLException - if the schema content is not inside a schema.

getTargetNamespace

URI getTargetNamespace()
                       throws XBRLException

Returns:

the target namespace of the schema that contains this fragment or null if no targetNamespace attribute is defined for the containing schema fragment.

Throws:

XBRLException

getOtherAttributes

List<Node> getOtherAttributes()
                              throws XBRLException

Returns:

a list of other (non XML Schema defined ) attributes on the root element of the Schema declaration. The list is empty if there are no other attributes.

Throws:

XBRLException

hasOtherAttribute

boolean hasOtherAttribute(URI namespace,
                          String localname)
                          throws XBRLException

Mirrors the hasAttributeNS method of the org.w3c.dom.Element class.

Parameters:

namespace - The namespace of the attribute being tested for

localname - The local name of the attribute being tested for

Returns:

true if the root element of the fragment has the specified attribute and false otherwise.

Throws:

XBRLException

getOtherAttribute

String getOtherAttribute(URI namespace,
                         String localname)
                         throws XBRLException

Mirrors the getAttributeNS method of the org.w3c.dom.Element class.

Parameters:

namespace - The namespace of the attribute being tested for

localname - The local name of the attribute being tested for

Returns:

the value of the attribute if it occurs on the root element of the fragment and null otherwise.

Throws:

XBRLException

getAnnotations

List<Element> getAnnotations()
                             throws XBRLException

Returns:

a list of annotation child elements for the given fragment or the empty list if there are no child annotations.

Throws:

XBRLException

getSchemaId

String getSchemaId()
                   throws XBRLException

Returns:

the the XML Schema ID attribute value or null if the schema content root element has no XML Schema ID attribute.

Throws:

XBRLException