|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.castor.core.nature.BaseNature
org.exolab.castor.builder.info.nature.XMLInfoNature
public final class XMLInfoNature
A XML specific view of a PropertyHolder
, which can be a ClassInfo
or a
FieldInfo
. Property based implementation.
Constructor Summary | |
---|---|
XMLInfoNature(PropertyHolder holder)
Constructor taking a PropertyHolder. |
Method Summary | |
---|---|
GroupInfo |
getGroupInfo()
Returns the GroupInfo for this XML nature. |
java.lang.String |
getId()
Implementation returns the fully qualified class name. |
java.lang.String |
getNamespacePrefix()
Returns the namespace prefix of the object described by this XMLInfo. |
java.lang.String |
getNamespaceURI()
Returns the namespace URI of the object described by this XMLInfo. |
java.lang.String |
getNodeName()
Returns the XML name for the object described by this XMLInfo. |
NodeType |
getNodeType()
Returns the node type for the object described by this XMLInfo. |
java.lang.String |
getNodeTypeName()
Returns the string name of the nodeType, either "attribute", "element" or "text". |
XSType |
getSchemaType()
Returns the XML Schema type for the described object. |
java.util.List<java.lang.String> |
getSubstitutionGroups()
Returns the possible substitution groups. |
boolean |
isChoice()
Returns true if the compositor of this GroupInfo is a choice. |
boolean |
isContainer()
Returns true if this ClassInfo describes a container class. |
boolean |
isElementDefinition()
Returns true if XSD is global element or element with anonymous type or false if property is not set. |
boolean |
isMultivalued()
Returns whether or not the object described by this XMLInfo is multi-valued (appears more than once in the XML document). |
boolean |
isRequired()
Return true if the XML object described by this XMLInfo must appear at least once in the XML document (or object model). |
boolean |
isSequence()
Returns true if the compositor of this GroupInfo is a sequence. |
void |
setContainer(boolean isContainer)
Sets whether or not this ClassInfo describes a container class. |
void |
setElementDefinition(boolean elementDef)
Sets whether or not XSD is element or not. |
void |
setGroupInfo(GroupInfo groupInfo)
Sets the GroupInfo for this XML nature. |
void |
setMultivalued(boolean multivalued)
Sets whether the XML object can appear more than once in the XML document. |
void |
setNamespacePrefix(java.lang.String nsPrefix)
Sets the desired namespace prefix for this XMLInfo There is no guarantee that this prefix will be used. |
void |
setNamespaceURI(java.lang.String nsURI)
Sets the Namespace URI for this XMLInfo. |
void |
setNodeName(java.lang.String name)
Sets the XML name of the object described by this XMLInfo. |
void |
setNodeType(NodeType nodeType)
Sets the nodeType for this XMLInfo. |
void |
setRequired(boolean required)
Sets whether or not the XML object must appear at least once. |
void |
setSchemaType(XSType xsType)
Sets the XML Schema type for this XMLInfo. |
void |
setSubstitutionGroups(java.util.List<java.lang.String> substitutionGroups)
Sets the possible substitution groups. |
Methods inherited from class org.castor.core.nature.BaseNature |
---|
getBooleanPropertyDefaultFalse, getHolder, getProperty, getPropertyAsList, getPropertyAsMap, setProperty |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLInfoNature(PropertyHolder holder)
holder
- in focus.Method Detail |
---|
public java.lang.String getId()
org.exolab.castor.builder.info.nature.Nature#getId()
public java.lang.String getNamespacePrefix()
public java.lang.String getNamespaceURI()
public java.lang.String getNodeName()
public NodeType getNodeType()
XMLInfo.ELEMENT_TYPE
if property is not set.
public java.lang.String getNodeTypeName()
public XSType getSchemaType()
public boolean isElementDefinition()
public boolean isMultivalued()
public boolean isRequired()
public void setElementDefinition(boolean elementDef)
elementDef
- The flag indicating whether or not XSD is global element,
element with anonymous type or not.public void setMultivalued(boolean multivalued)
multivalued
- The boolean indicating whether or not the object can appear
more than once.public void setNamespacePrefix(java.lang.String nsPrefix)
nsPrefix
- the desired namespace prefixpublic void setNamespaceURI(java.lang.String nsURI)
nsURI
- the Namespace URI for this XMLInfopublic void setNodeName(java.lang.String name)
name
- the XML node name of the described object.public void setNodeType(NodeType nodeType)
nodeType
- the node type of the described objectpublic void setRequired(boolean required)
required
- the flag indicating whether or not this XML object is requiredpublic void setSchemaType(XSType xsType)
xsType
- the XML Schema typepublic java.util.List<java.lang.String> getSubstitutionGroups()
public void setSubstitutionGroups(java.util.List<java.lang.String> substitutionGroups)
substitutionGroups
- Possible substitution groups.public boolean isContainer()
public void setContainer(boolean isContainer)
isContainer
- the boolean value when true indicates this class
should be a container class.public GroupInfo getGroupInfo()
GroupInfo
for this XML nature.
GroupInfo
instance.public void setGroupInfo(GroupInfo groupInfo)
GroupInfo
for this XML nature.
groupInfo
- the GroupInfo
instance.public boolean isChoice()
public boolean isSequence()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |