org.xbrlapi

Interface TypeDeclaration

All Superinterfaces:

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

All Known Subinterfaces:

ComplexTypeDeclaration, SimpleTypeDeclaration

All Known Implementing Classes:

ComplexTypeDeclarationImpl, SimpleTypeDeclarationImpl, TypeDeclarationImpl

public interface TypeDeclaration
extends SchemaDeclaration

base interface for all type declarations in XML Schemas.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFinal()
TypeDeclaration	getParentType()
java.lang.String	getParentTypeLocalname()
java.lang.String	getParentTypeNamespace()
boolean	isDerivedFrom(java.lang.String namespace, java.lang.String name)
boolean	isDerivedFrom(TypeDeclaration candidate)
boolean	isFinal()
boolean	isFinalForExtension()
boolean	isFinalForRestriction()
boolean	isNumericItemType()

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

getFinal

java.lang.String getFinal()
                          throws XBRLException

Returns:

the final attribute value or null if there is none. One of #all or list of extension and restriction

Throws:

XBRLException

isFinalForExtension

boolean isFinalForExtension()
                            throws XBRLException

Returns:

true iff the type declaration cannot be extended.

Throws:

XBRLException

isFinalForRestriction

boolean isFinalForRestriction()
                              throws XBRLException

Returns:

true iff the type declaration cannot be restricted.

Throws:

XBRLException

isFinal

boolean isFinal()
                throws XBRLException

Returns:

true iff the type declaration cannot be extended or restricted.

Throws:

XBRLException

isDerivedFrom

boolean isDerivedFrom(java.lang.String namespace,
                    java.lang.String name)
                      throws XBRLException

Parameters:

namespace - The namespace of the prospective type.

name - The local name of the prospective type.

Returns:

true if this type declaration is or is derived from the specified type declaration.

Throws:

XBRLException - if there is no type declaration with the given namespace and name.

isDerivedFrom

boolean isDerivedFrom(TypeDeclaration candidate)
                      throws XBRLException

Parameters:

candidate - the type declaration that this type may be derived from.

Returns:

true if this type declaration is or is derived from the specified ancestor type declaration.

Throws:

XBRLException

getParentType

TypeDeclaration getParentType()
                              throws XBRLException

Returns:

the type that this type extends or restricts or null if the type that is extended or restricted is a type defined in the XML Schema specifications.

Throws:

XBRLException

getParentTypeNamespace

java.lang.String getParentTypeNamespace()
                                        throws XBRLException

Returns:

the namespace of the type that this type declaration extends or restricts.

Throws:

XBRLException

getParentTypeLocalname

java.lang.String getParentTypeLocalname()
                                        throws XBRLException

Returns:

the local name of the type that this type declaration extends or restricts.

Throws:

XBRLException

isNumericItemType

boolean isNumericItemType()
                          throws XBRLException

Returns:

true if the type is derived from or is an XBRL numeric item type.

Throws:

XBRLException