public interface Field<CONVERSION_MANAGER extends ConversionManager,NAMESPACE_RESOLVER extends NamespaceResolver> extends CoreField
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
convertValueBasedOnSchemaType(java.lang.Object value,
CONVERSION_MANAGER xmlConversionManager,
AbstractUnmarshalRecord record)
INTERNAL:
Called from DOMRecord and XMLReader.
|
java.lang.Class |
getJavaClass(javax.xml.namespace.QName qname,
ConversionManager conversionManager)
Return the class for a given qualified XML Schema type
|
XPathFragment |
getLastXPathFragment()
INTERNAL:
Return the last XPathFragment.
|
javax.xml.namespace.QName |
getLeafElementType() |
java.lang.String |
getName()
Return the unqualified name of the field.
|
NAMESPACE_RESOLVER |
getNamespaceResolver()
Get the NamespaceResolver associated with this XMLField
|
javax.xml.namespace.QName |
getSchemaType()
Return the schema type associated with this field
|
javax.xml.namespace.QName |
getSchemaTypeForValue(java.lang.Object value,
CoreAbstractSession session)
INTERNAL:
|
java.lang.Class |
getType() |
javax.xml.namespace.QName |
getXMLType(java.lang.Class javaClass,
ConversionManager conversionManager)
Return the qualified XML Schema type for a given class
|
java.lang.String |
getXPath()
Returns the xpath statement associated with this XMLField
|
XPathFragment |
getXPathFragment()
INTERNAL:
Maintain a direct pointer to the first XPathFragment.
|
boolean |
hasLastXPathFragment()
INTERNAL:
|
void |
initialize() |
boolean |
isCDATA()
INTERNAL:
|
boolean |
isRequired()
Indicates if this XMLField represents a "required" XML element or attribute
([minOccurs="1"] for elements, [use="required"] for attributes).
|
boolean |
isSchemaType(javax.xml.namespace.QName schemaType)
INTERNAL
|
boolean |
isSelfField()
INTERNAL:
Indicates if the xpath for this field is "."
|
boolean |
isTypedTextField()
Returns if the field is a typed text field
True when we should base conversions on the "type" attribute on elements
|
boolean |
isUnionField()
INTERNAL:
Returns false since this is a union field
The subclass XMLUnionField returns true for this
|
void |
setIsCDATA(boolean CDATA)
INTERNAL:
|
void |
setIsTypedTextField(boolean value)
Set if the field is a typed text field
True when we should base conversions on the "type" attribute on elements
|
void |
setNamespaceResolver(NAMESPACE_RESOLVER newNamespaceResolver)
Set the NamespaceResolver associated with this XMLField
|
void |
setRequired(boolean isRequired)
Set whether this XMLField represents a "required" XML element or attribute
([minOccurs="1"] for elements, [use="required"] for attributes).
|
void |
setSchemaType(javax.xml.namespace.QName value)
Sets the schematype associated with this XMLField
This is an optional setting; when set the schema type will be used to format the XML appropriately
|
void |
setUsesSingleNode(boolean usesSingleNode)
Sets whether the mapping uses a single node.
|
void |
setXPath(java.lang.String xPath)
Set the xpath statment for this XMLField.
|
boolean |
usesSingleNode()
Checks whether the mapping uses a single node.
|
java.lang.Object convertValueBasedOnSchemaType(java.lang.Object value, CONVERSION_MANAGER xmlConversionManager, AbstractUnmarshalRecord record)
java.lang.Class getJavaClass(javax.xml.namespace.QName qname, ConversionManager conversionManager)
qname
- The qualified name of the XML Schema type to use as a key in the lookupXPathFragment getLastXPathFragment()
javax.xml.namespace.QName getLeafElementType()
java.lang.String getName()
NAMESPACE_RESOLVER getNamespaceResolver()
javax.xml.namespace.QName getSchemaType()
javax.xml.namespace.QName getSchemaTypeForValue(java.lang.Object value, CoreAbstractSession session)
javax.xml.namespace.QName getXMLType(java.lang.Class javaClass, ConversionManager conversionManager)
javaClass
- The class to use as a key in the lookupjava.lang.String getXPath()
XPathFragment getXPathFragment()
boolean hasLastXPathFragment()
void initialize()
boolean isCDATA()
boolean isRequired()
SchemaModelGenerator
boolean isSchemaType(javax.xml.namespace.QName schemaType)
boolean isSelfField()
boolean isTypedTextField()
boolean isUnionField()
void setIsCDATA(boolean CDATA)
CDATA
- void setIsTypedTextField(boolean value)
value
- The boolean value specifiy if this is a typed text fieldvoid setNamespaceResolver(NAMESPACE_RESOLVER newNamespaceResolver)
newNamespaceResolver
- The namespaceResolver to be associated with this XMLFieldvoid setRequired(boolean isRequired)
SchemaModelGenerator
void setSchemaType(javax.xml.namespace.QName value)
value
- QName to be added to the list of schema typesvoid setUsesSingleNode(boolean usesSingleNode)
usesSingleNode
- True if the items in the collection are in a single node or false if each of the items in the collection is in its own nodevoid setXPath(java.lang.String xPath)
xPath
- The xpath statement to be associated with this XMLFieldboolean usesSingleNode()
EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference