public interface Schema extends SchemaContent
Modifier and Type | Method and Description |
---|---|
java.util.List<ArcroleType> |
getArcroleTypes() |
Concept |
getConceptByName(java.lang.String name)
Get a specific concept by its name.
|
long |
getConceptCount()
Get the number of concepts defined in the schema.
|
java.util.List<Concept> |
getConcepts()
Get the fragment list of concepts in the schema.
|
java.util.List<Concept> |
getConceptsBySubstitutionGroup(java.lang.String namespace,
java.lang.String localname)
Get a list concepts based on their substitution group.
|
java.util.List<Concept> |
getConceptsByType(java.lang.String namespace,
java.lang.String localName)
Get a list of concepts based on their type.
|
java.util.List<ExtendedLink> |
getExtendedLinks() |
java.util.List<ComplexTypeDeclaration> |
getGlobalComplexTypes() |
<D extends SchemaDeclaration> |
getGlobalDeclaration(java.lang.String name) |
java.util.List<SimpleTypeDeclaration> |
getGlobalSimpleTypes() |
java.util.List<Schema> |
getImporters() |
java.util.List<SimpleLink> |
getImports() |
java.util.List<SimpleLink> |
getIncludes() |
java.util.List<Concept> |
getOtherElementDeclarations()
Get the fragment list of element declarations (that are not concepts) in the schema.
|
ReferencePartDeclaration |
getReferencePartDeclaration(java.lang.String name)
Get a reference part declaration in a schema.
|
java.util.List<ReferencePartDeclaration> |
getReferencePartDeclarations()
Get a list of the reference part declarations in a schema.
|
java.util.List<RoleType> |
getRoleTypes() |
boolean |
isElementFormQualified()
Checks if the element form is qualified.
|
getAnnotations, getOtherAttribute, getOtherAttributes, getSchema, getSchemaId, getTargetNamespace, hasOtherAttribute
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
appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore
boolean isElementFormQualified() throws XBRLException
XBRLException
java.util.List<SimpleLink> getImports() throws XBRLException
XBRLException
java.util.List<Schema> getImporters() throws XBRLException
XBRLException
java.util.List<SimpleLink> getIncludes() throws XBRLException
XBRLException
java.util.List<ExtendedLink> getExtendedLinks() throws XBRLException
XBRLException
java.util.List<Concept> getOtherElementDeclarations() throws XBRLException
XBRLException.
XBRLException
java.util.List<Concept> getConcepts() throws XBRLException
XBRLException.
XBRLException
long getConceptCount() throws XBRLException
XBRLException.
XBRLException
Concept getConceptByName(java.lang.String name) throws XBRLException
name
- The name of the conceptXBRLException
java.util.List<Concept> getConceptsByType(java.lang.String namespace, java.lang.String localName) throws XBRLException
namespace
- The namespaceURI of the concept typelocalName
- The local name of the concept typeXBRLException
java.util.List<Concept> getConceptsBySubstitutionGroup(java.lang.String namespace, java.lang.String localname) throws XBRLException
namespace
- The namespaceURI of the concept typelocalname
- The local name of the concept typeXBRLException
ReferencePartDeclaration getReferencePartDeclaration(java.lang.String name) throws XBRLException
name
- The name attribute value of the reference part to be retrieved.XBRLException
java.util.List<ReferencePartDeclaration> getReferencePartDeclarations() throws XBRLException
XBRLException
java.util.List<RoleType> getRoleTypes() throws XBRLException
XBRLException
java.util.List<ArcroleType> getArcroleTypes() throws XBRLException
XBRLException
java.util.List<ComplexTypeDeclaration> getGlobalComplexTypes() throws XBRLException
XBRLException
java.util.List<SimpleTypeDeclaration> getGlobalSimpleTypes() throws XBRLException
XBRLException
<D extends SchemaDeclaration> D getGlobalDeclaration(java.lang.String name) throws XBRLException
D
- The type of the declaration being retrieved.name
- The name of the declaration being retrieved.XBRLException
- if the name is null or if the specified type of the global
declaration is not consistent with the actual type of the declaration.