|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XSDSchema
A representation of the model object 'Schema'.
The following features are supported:
Document
Schema Location
Target Namespace
Attribute Form Default
Element Form Default
Final Default
Block Default
Version
Contents
Element Declarations
Attribute Declarations
Attribute Group Definitions
Type Definitions
Model Group Definitions
Identity Constraint Definitions
Notation Declarations
Annotations
All Diagnostics
Referencing Directives
Root Version
Original Version
Incorporated Versions
Schema For Schema
XSDPackage.getXSDSchema()
Method Summary | |
---|---|
EList<XSDDiagnostic> |
getAllDiagnostics()
Returns the value of the 'All Diagnostics' reference list. |
EList<XSDAnnotation> |
getAnnotations()
Returns the value of the 'Annotations' reference list. |
EList<XSDAttributeDeclaration> |
getAttributeDeclarations()
Returns the value of the 'Attribute Declarations' reference list. |
XSDForm |
getAttributeFormDefault()
Returns the value of the 'Attribute Form Default' attribute. |
EList<XSDAttributeGroupDefinition> |
getAttributeGroupDefinitions()
Returns the value of the 'Attribute Group Definitions' reference list. |
EList<XSDDisallowedSubstitutions> |
getBlockDefault()
Returns the value of the 'Block Default' attribute list. |
EList<XSDSchemaContent> |
getContents()
Returns the value of the 'Contents' containment reference list. |
XSDConcreteComponent |
getCorrespondingComponent(org.w3c.dom.Node node)
Returns the best concrete component that corresponds to the given node. |
org.w3c.dom.Document |
getDocument()
Returns the value of the 'Document' attribute |
EList<XSDElementDeclaration> |
getElementDeclarations()
Returns the value of the 'Element Declarations' reference list. |
XSDForm |
getElementFormDefault()
Returns the value of the 'Element Form Default' attribute. |
EList<XSDProhibitedSubstitutions> |
getFinalDefault()
Returns the value of the 'Final Default' attribute list. |
EList<XSDIdentityConstraintDefinition> |
getIdentityConstraintDefinitions()
Returns the value of the 'Identity Constraint Definitions' reference list. |
EList<XSDSchema> |
getIncorporatedVersions()
Returns the value of the 'Incorporated Versions' containment reference list. |
EList<XSDModelGroupDefinition> |
getModelGroupDefinitions()
Returns the value of the 'Model Group Definitions' reference list. |
EList<XSDNotationDeclaration> |
getNotationDeclarations()
Returns the value of the 'Notation Declarations' reference list. |
XSDSchema |
getOriginalVersion()
Returns the value of the 'Original Version' reference |
java.util.Map<java.lang.String,java.lang.String> |
getQNamePrefixToNamespaceMap()
Returns the map defined by the xmlns attributes of the underlying XML representation. |
EList<XSDSchemaDirective> |
getReferencingDirectives()
Returns the value of the 'Referencing Directives' reference list. |
XSDSchema |
getRootVersion()
Returns the value of the 'Root Version' reference |
XSDSchema |
getSchemaForSchema()
Returns the value of the 'Schema For Schema' reference |
java.lang.String |
getSchemaForSchemaNamespace()
Returns the schema for schema namespace of this schema. |
java.lang.String |
getSchemaForSchemaQNamePrefix()
Returns the QName prefix used to reference the schema for schema namespace . |
java.lang.String |
getSchemaLocation()
Returns the value of the 'Schema Location' attribute |
java.util.Map<java.lang.String,XSDSimpleTypeDefinition> |
getSimpleTypeIdMap()
Returns a map from String ID to XSDSimpleTypeDefinition
based on the IDs in the DOM representation. |
java.lang.String |
getStringBlockDefault()
Returns the String value of the ' Block Default ' attribute list |
java.lang.String |
getStringFinalDefault()
Returns the String value of the ' Final Default ' attribute list |
java.lang.String |
getTargetNamespace()
Returns the value of the 'Target Namespace' attribute |
EList<XSDTypeDefinition> |
getTypeDefinitions()
Returns the value of the 'Type Definitions' reference list. |
java.lang.String |
getVersion()
Returns the value of the 'Version' attribute |
boolean |
isIncrementalUpdate()
Returns whether the schema will incrementally resolve QNames and perform analysis after each edit change. |
boolean |
isSetAttributeFormDefault()
Returns whether the value of the ' Attribute Form Default ' attribute is set |
boolean |
isSetBlockDefault()
Returns whether the value of the ' Block Default ' attribute list is set |
boolean |
isSetElementFormDefault()
Returns whether the value of the ' Element Form Default ' attribute is set |
boolean |
isSetFinalDefault()
Returns whether the value of the ' Final Default ' attribute list is set |
void |
reset()
Resets the effects of imports, includes, and redefines so that they will be reprocessed. |
void |
setAttributeFormDefault(XSDForm value)
Sets the value of the ' Attribute Form Default ' attribute |
void |
setDocument(org.w3c.dom.Document value)
Sets the value of the ' Document ' attribute |
void |
setElementFormDefault(XSDForm value)
Sets the value of the ' Element Form Default ' attribute |
void |
setIncrementalUpdate(boolean isIncrementalUpdate)
Sets whether the schema will incrementally resolve QNames and perform analysis after each edit change. |
void |
setSchemaForSchemaQNamePrefix(java.lang.String qNamePrefix)
Sets the QName prefix used to reference the schema for schema namespace . |
void |
setSchemaLocation(java.lang.String value)
Sets the value of the ' Schema Location ' attribute |
void |
setStringBlockDefault(java.lang.String blockDefault)
Returns the String value of the ' Block Default ' attribute list |
void |
setStringFinalDefault(java.lang.String finalDefault)
Set the String value of the ' Final Default ' attribute list |
void |
setTargetNamespace(java.lang.String value)
Sets the value of the ' Target Namespace ' attribute |
void |
setVersion(java.lang.String value)
Sets the value of the ' Version ' attribute |
void |
unsetAttributeFormDefault()
Unsets the value of the ' Attribute Form Default ' attribute |
void |
unsetBlockDefault()
Unsets the value of the ' Block Default ' attribute list |
void |
unsetElementFormDefault()
Unsets the value of the ' Element Form Default ' attribute |
void |
unsetFinalDefault()
Unsets the value of the ' Final Default ' attribute list |
void |
update()
Resolves QNames and performs analysis. |
void |
update(boolean force)
Resolves QNames and performs analysis. |
org.w3c.dom.Document |
updateDocument()
Ensures that the document will be set to an instance that can be used to create a DOM serialization. |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
---|
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
---|
eAdapters, eDeliver, eNotify, eSetDeliver |
Method Detail |
---|
org.w3c.dom.Document getDocument()
This is the optional DOM document of this schema,
i.e., the owner of the element
.
A document can be created by calling updateDocument()
;
a document and an element can be create by calling XSDConcreteComponent.updateElement()
.
setDocument(Document)
,
XSDPackage.getXSDSchema_Document()
void setDocument(org.w3c.dom.Document value)
Document
' attribute.
value
- the new value of the 'Document' attribute.getDocument()
java.lang.String getSchemaLocation()
This concrete attribute represents the URI of the resource that contains this this schema.
It is used to complete any relative schemaLocation
URI
in an import, include, or redefine.
No schema resolution
will be attempted until this has been set.
setSchemaLocation(String)
,
XSDPackage.getXSDSchema_SchemaLocation()
void setSchemaLocation(java.lang.String value)
Schema Location
' attribute.
value
- the new value of the 'Schema Location' attribute.getSchemaLocation()
java.lang.String getTargetNamespace()
This concrete attribute represents the value of the targetNamespace attribute.
setTargetNamespace(String)
,
XSDPackage.getXSDSchema_TargetNamespace()
void setTargetNamespace(java.lang.String value)
Target Namespace
' attribute.
value
- the new value of the 'Target Namespace' attribute.getTargetNamespace()
XSDForm getAttributeFormDefault()
"unqualified"
.
The literals are from the enumeration XSDForm
.
This concrete attribute represents the value of the attributeFormDefault attribute.
XSDForm
,
isSetAttributeFormDefault()
,
unsetAttributeFormDefault()
,
setAttributeFormDefault(XSDForm)
,
XSDPackage.getXSDSchema_AttributeFormDefault()
void setAttributeFormDefault(XSDForm value)
Attribute Form Default
' attribute.
value
- the new value of the 'Attribute Form Default' attribute.XSDForm
,
isSetAttributeFormDefault()
,
unsetAttributeFormDefault()
,
getAttributeFormDefault()
void unsetAttributeFormDefault()
Attribute Form Default
' attribute.
isSetAttributeFormDefault()
,
getAttributeFormDefault()
,
setAttributeFormDefault(XSDForm)
boolean isSetAttributeFormDefault()
Attribute Form Default
' attribute is set.
unsetAttributeFormDefault()
,
getAttributeFormDefault()
,
setAttributeFormDefault(XSDForm)
XSDForm getElementFormDefault()
"unqualified"
.
The literals are from the enumeration XSDForm
.
This concrete attribute represents the value of the elementFormDefault attribute.
XSDForm
,
isSetElementFormDefault()
,
unsetElementFormDefault()
,
setElementFormDefault(XSDForm)
,
XSDPackage.getXSDSchema_ElementFormDefault()
void setElementFormDefault(XSDForm value)
Element Form Default
' attribute.
value
- the new value of the 'Element Form Default' attribute.XSDForm
,
isSetElementFormDefault()
,
unsetElementFormDefault()
,
getElementFormDefault()
void unsetElementFormDefault()
Element Form Default
' attribute.
isSetElementFormDefault()
,
getElementFormDefault()
,
setElementFormDefault(XSDForm)
boolean isSetElementFormDefault()
Element Form Default
' attribute is set.
unsetElementFormDefault()
,
getElementFormDefault()
,
setElementFormDefault(XSDForm)
EList<XSDProhibitedSubstitutions> getFinalDefault()
XSDProhibitedSubstitutions
.
The literals are from the enumeration XSDProhibitedSubstitutions
.
This concrete attribute represents the value of the finalDefault attribute.
XSDProhibitedSubstitutions
,
isSetFinalDefault()
,
unsetFinalDefault()
,
XSDPackage.getXSDSchema_FinalDefault()
void unsetFinalDefault()
Final Default
' attribute list.
isSetFinalDefault()
,
getFinalDefault()
boolean isSetFinalDefault()
Final Default
' attribute list is set.
unsetFinalDefault()
,
getFinalDefault()
java.lang.String getStringFinalDefault()
Final Default
' attribute list.
getFinalDefault()
,
setStringFinalDefault(java.lang.String)
void setStringFinalDefault(java.lang.String finalDefault)
Final Default
' attribute list.
finalDefault
- the new value of the 'Final Default' attribute list.getFinalDefault()
,
getStringFinalDefault()
EList<XSDDisallowedSubstitutions> getBlockDefault()
XSDDisallowedSubstitutions
.
The literals are from the enumeration XSDDisallowedSubstitutions
.
This concrete attribute represents the value of the blockDefault attribute.
XSDDisallowedSubstitutions
,
isSetBlockDefault()
,
unsetBlockDefault()
,
XSDPackage.getXSDSchema_BlockDefault()
void unsetBlockDefault()
Block Default
' attribute list.
isSetBlockDefault()
,
getBlockDefault()
boolean isSetBlockDefault()
Block Default
' attribute list is set.
unsetBlockDefault()
,
getBlockDefault()
java.lang.String getVersion()
This concrete attribute represents the value of the version attribute.
setVersion(String)
,
XSDPackage.getXSDSchema_Version()
void setVersion(java.lang.String value)
Version
' attribute.
value
- the new value of the 'Version' attribute.getVersion()
java.lang.String getStringBlockDefault()
Block Default
' attribute list.
getBlockDefault()
,
setStringBlockDefault(java.lang.String)
void setStringBlockDefault(java.lang.String blockDefault)
Block Default
' attribute list.
blockDefault
- the new value of the 'Block Default' attribute list.getBlockDefault()
,
getStringBlockDefault()
EList<XSDSchemaContent> getContents()
XSDSchemaContent
.
This concrete reference represents the contents defined within the body of a schema element.
XSDPackage.getXSDSchema_Contents()
EList<XSDElementDeclaration> getElementDeclarations()
XSDElementDeclaration
.
This represents the
element declarations
infoset property.
It is computed from the contents
and should typically not be set directly.
XSDPackage.getXSDSchema_ElementDeclarations()
EList<XSDAttributeDeclaration> getAttributeDeclarations()
XSDAttributeDeclaration
.
This represents the
attribute declarations
infoset property.
It is computed from the contents
and should typically not be set directly.
XSDPackage.getXSDSchema_AttributeDeclarations()
EList<XSDAttributeGroupDefinition> getAttributeGroupDefinitions()
XSDAttributeGroupDefinition
.
This represents the
attribute group definitions
infoset property.
It is computed from the contents
and should typically not be set directly.
XSDPackage.getXSDSchema_AttributeGroupDefinitions()
EList<XSDTypeDefinition> getTypeDefinitions()
XSDTypeDefinition
.
This represents the
type definitions
infoset property.
It is computed from the contents
and should typically not be set directly.
XSDPackage.getXSDSchema_TypeDefinitions()
EList<XSDModelGroupDefinition> getModelGroupDefinitions()
XSDModelGroupDefinition
.
This represents the
model group definitions
infoset property.
It is computed from the contents
and should typically not be set directly.
XSDPackage.getXSDSchema_ModelGroupDefinitions()
EList<XSDIdentityConstraintDefinition> getIdentityConstraintDefinitions()
XSDIdentityConstraintDefinition
.
This represents the
identity constraint definitions
infoset property.
It is computed from the contents
and should typically not be set directly.
Actually, there is no such property defined
but this seems to be an oversight;
it is needed to resolve a referenced key
.
XSDPackage.getXSDSchema_IdentityConstraintDefinitions()
EList<XSDNotationDeclaration> getNotationDeclarations()
XSDNotationDeclaration
.
This represents the
notation declarations
infoset property.
It is computed from the contents
and should typically not be set directly.
XSDPackage.getXSDSchema_NotationDeclarations()
EList<XSDAnnotation> getAnnotations()
XSDAnnotation
.
This represents the
annotations
infoset property.
It is computed from the contents
and should typically not be set directly.
XSDPackage.getXSDSchema_Annotations()
EList<XSDDiagnostic> getAllDiagnostics()
XSDDiagnostic
.
This concrete reference represents all the diagnostics that occur within the components of this schema.
It is computed from the 'Diagnostics
' reference list
and should typically not be modified directly.
XSDPackage.getXSDSchema_AllDiagnostics()
EList<XSDSchemaDirective> getReferencingDirectives()
XSDSchemaDirective
.
This represents the directives that have this schema as their
'Resolved Schema
' reference or
'Incorporated Schema
' reference.
XSDPackage.getXSDSchema_ReferencingDirectives()
XSDSchema getRootVersion()
This walks the original versions
until it hits one that has no original version.
XSDPackage.getXSDSchema_RootVersion()
XSDSchema getOriginalVersion()
This represents the schema from which an incorporated version
originates.
The root version
has itself as its original version.
XSDPackage.getXSDSchema_OriginalVersion()
EList<XSDSchema> getIncorporatedVersions()
XSDSchema
.
This represents those versions of this schema
that have been included
into a schema with a different namespace
or have been otherwise redefined
.
XSDSchemaCompositor.getIncorporatedSchema()
,
XSDPackage.getXSDSchema_IncorporatedVersions()
XSDSchema getSchemaForSchema()
This represents the
'schema for schemas'.
It is computed from the schema for schema namespace
and should typically not be set directly.
XSDPackage.getXSDSchema_SchemaForSchema()
XSDConcreteComponent getCorrespondingComponent(org.w3c.dom.Node node)
node
- the node to find.
XSDConcreteComponent.getElement()
java.util.Map<java.lang.String,XSDSimpleTypeDefinition> getSimpleTypeIdMap()
XSDSimpleTypeDefinition
based on the IDs in the DOM representation.
For the schema for schema
,
this represents the
built-in datatypes.
XSDSimpleTypeDefinition
getSchemaForSchema()
java.util.Map<java.lang.String,java.lang.String> getQNamePrefixToNamespaceMap()
schema for schema namespace prefix
.
Note that the default prefix is represented as null
not as a zero length string.
getSchemaForSchemaQNamePrefix()
,
getSchemaForSchemaNamespace()
java.lang.String getSchemaForSchemaQNamePrefix()
schema for schema namespace
.
It must be a key in getQNamePrefixToNamespaceMap()
.
It is recommended that the prefix 'xsd
' be used.
setSchemaForSchemaQNamePrefix(java.lang.String)
,
getQNamePrefixToNamespaceMap()
void setSchemaForSchemaQNamePrefix(java.lang.String qNamePrefix)
schema for schema namespace
.
It must be a key in getQNamePrefixToNamespaceMap()
that maps to a valid
schema for schema namespace.
qNamePrefix
- the new schema for schema QName prefix.getSchemaForSchemaQNamePrefix()
,
getQNamePrefixToNamespaceMap()
java.lang.String getSchemaForSchemaNamespace()
(String)so you can't set this directly.getQNamePrefixToNamespaceMap()
.get(getSchemaForSchemaQNamePrefix()
)
getQNamePrefixToNamespaceMap()
,
getSchemaForSchemaQNamePrefix()
org.w3c.dom.Document updateDocument()
document
will be set to an instance that can be used to create a DOM serialization.
XSDConcreteComponent.updateElement()
boolean isIncrementalUpdate()
setIncrementalUpdate(boolean)
,
update()
void setIncrementalUpdate(boolean isIncrementalUpdate)
true
will also result in an update.
isIncrementalUpdate
- the new value.isIncrementalUpdate()
,
update()
void update()
isIncrementalUpdate()
,
update()
void update(boolean force)
force
is true
even previously resolved QNames are resolved again.
force
- whether previously resolved names should be resolved again.isIncrementalUpdate()
,
update()
void reset()
update()
|
Copyright 2001-2006 IBM Corporation and others. All Rights Reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |