Public Member Functions | |
| XMLFieldDescriptorImpl (Class fieldType, String fieldName, String xmlName, NodeType nodeType) | |
| XMLFieldDescriptorImpl (XMLFieldDescriptor fieldDesc) throws MappingException | |
| XMLFieldDescriptorImpl (FieldDescriptor fieldDesc, String xmlName, NodeType nodeType) throws MappingException | |
| XMLFieldDescriptorImpl (FieldDescriptor fieldDesc, String xmlName, NodeType nodeType, NodeType primitiveNodeType) throws MappingException | |
| boolean | equals (Object obj) |
| int | hashCode () |
| void | setContainingClassDescriptor (ClassDescriptor contClsDesc) |
| ClassDescriptor | getContainingClassDescriptor () |
| ClassDescriptor | getClassDescriptor () |
| CollectionHandler | getCollectionHandler () |
| int | getConstructorArgumentIndex () |
| String | getFieldName () |
| Class | getFieldType () |
| FieldHandler | getHandler () |
| String | getXMLName () |
| String | getNameSpacePrefix () |
| String | getNameSpaceURI () |
| NodeType | getNodeType () |
| String | getLocationPath () |
| String | getProperty (String propertyName) |
| String | getQNamePrefix () |
| FieldValidator | getValidator () |
| String | getSchemaType () |
| boolean | isConstructorArgument () |
| boolean | isContainer () |
| boolean | isImmutable () |
| boolean | isIncremental () |
| boolean | isMapped () |
| boolean | isMultivalued () |
| boolean | isNillable () |
| boolean | isReference () |
| boolean | isRequired () |
| boolean | isTransient () |
| void | setContainer (boolean isContainer) |
| boolean | matches (String xmlName) |
| boolean | matches (String xmlName, String namespace) |
| void | setClassDescriptor (XMLClassDescriptor classDescriptor) |
| void | setConstructorArgumentIndex (int index) |
| void | setHandler (FieldHandler handler) |
| void | setIncremental (boolean incremental) |
| void | setImmutable (boolean immutable) |
| void | setLocationPath (String path) |
| void | setMapped (boolean mapped) |
| void | setMatches (String matchExpr) |
| void | setMultivalued (boolean multivalued) |
| void | setNillable (boolean nillable) |
| void | setProperty (String propertyName, String value) |
| void | setSchemaType (String schemaType) |
| void | setQNamePrefix (String qNamePrefix) |
| void | setReference (boolean isReference) |
| void | setNameSpacePrefix (String nsPrefix) |
| void | setNameSpaceURI (String nsURI) |
| void | setNodeType (NodeType nodeType) |
| void | setRequired (boolean required) |
| void | setTransient (boolean isTransient) |
| void | setUseParentsNamespace (boolean useParentsNamespace) |
| void | setValidator (FieldValidator validator) |
| void | setXMLName (String xmlName) |
| String | toString () |
Public Attributes | |
| boolean | _isReference = false |
| boolean | _required = false |
Protected Member Functions | |
| boolean | hasNonDefaultMatching () |
Static Protected Member Functions | |
| static boolean | isPrimitive (Class type) |
XML field descriptor. Wraps FieldDescriptor and adds XML-related information, type conversion, etc.
| org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl | ( | Class | fieldType, | |
| String | fieldName, | |||
| String | xmlName, | |||
| NodeType | nodeType | |||
| ) |
| org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl | ( | XMLFieldDescriptor | fieldDesc | ) | throws MappingException |
Makes a new copy of the given XMLFieldDescriptorImpl
| fieldDesc | The XMLFieldDescriptor to copy |
| MappingException | Invalid mapping information |
| org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl | ( | FieldDescriptor | fieldDesc, | |
| String | xmlName, | |||
| NodeType | nodeType | |||
| ) | throws MappingException |
Construct a new field descriptor for the specified field. This is an XML field descriptor wrapping a field descriptor and adding XML related properties and methods.
| fieldDesc | The field descriptor | |
| xmlName | The XML name of the field | |
| nodeType | The node type of this field |
| MappingException | Invalid mapping information |
| org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl | ( | FieldDescriptor | fieldDesc, | |
| String | xmlName, | |||
| NodeType | nodeType, | |||
| NodeType | primitiveNodeType | |||
| ) | throws MappingException |
Construct a new field descriptor for the specified field. This is an XML field descriptor wrapping a field descriptor and adding XML related properties and methods.
| fieldDesc | The field descriptor | |
| xmlName | The XML name of the field | |
| nodeType | The node type of this field |
| MappingException | Invalid mapping information |
References org.exolab.castor.xml.util.XMLFieldDescriptorImpl._required, org.exolab.castor.xml.NodeType.Attribute, org.exolab.castor.xml.NodeType.Element, org.exolab.castor.mapping.FieldDescriptor.getClassDescriptor(), org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getFieldName(), org.exolab.castor.mapping.FieldDescriptor.getFieldName(), org.exolab.castor.mapping.FieldDescriptor.getFieldType(), org.exolab.castor.mapping.FieldDescriptor.getHandler(), org.exolab.castor.mapping.FieldDescriptor.isImmutable(), org.exolab.castor.mapping.FieldDescriptor.isMultivalued(), org.exolab.castor.mapping.FieldDescriptor.isRequired(), org.exolab.castor.mapping.FieldDescriptor.isTransient(), org.exolab.castor.xml.FieldValidator.setDescriptor(), org.exolab.castor.xml.FieldValidator.setMinOccurs(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setXMLName().
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.equals | ( | Object | obj | ) |
Returns true if two XMLFieldDescriptors should be treated as equal. Any XMLFieldDescriptor that handles the same field is considered equal.
References org.exolab.castor.mapping.FieldDescriptor.getFieldName(), org.exolab.castor.mapping.FieldDescriptor.getFieldType(), and org.exolab.castor.mapping.FieldDescriptor.getHandler().
| ClassDescriptor org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getClassDescriptor | ( | ) |
Returns the class descriptor related to the field type. If the field type is a class for which a descriptor exists, this descriptor is returned. If the field type is a class for which no mapping is provided, null is returned.
Implements org.exolab.castor.mapping.FieldDescriptor.
| CollectionHandler org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getCollectionHandler | ( | ) |
Return the collection handler of this field type. Returns null if the field is not a collection.
| int org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getConstructorArgumentIndex | ( | ) |
Returns the index within the constructor argument array where the value of this field should be. A value less than zero indicates that the value of this field is set via a normal setter method and not via the constructor.
Note: This only applies to attribute mapped fields at this time.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| ClassDescriptor org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getContainingClassDescriptor | ( | ) |
Implements org.exolab.castor.mapping.FieldDescriptor.
| String org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getFieldName | ( | ) |
Returns the name of the field.
Implements org.exolab.castor.mapping.FieldDescriptor.
Referenced by org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
| Class org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getFieldType | ( | ) |
Returns the Java type of the field.
Implements org.exolab.castor.mapping.FieldDescriptor.
Reimplemented in org.exolab.castor.xml.XMLMappingLoader.ContainerElementFieldDescriptor.
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), and org.exolab.castor.xml.Introspector.generateClassDescriptor().
| FieldHandler org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getHandler | ( | ) |
Returns the handler of the field. In order to persist or marshal a field descriptor will be associated with a handler.
Implements org.exolab.castor.mapping.FieldDescriptor.
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), and org.exolab.castor.xml.Introspector.generateClassDescriptor().
| String org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getLocationPath | ( | ) |
Returns the "relative" XML path for the field being described.
In most cases, this will be null. However sometimes a field may be mapped to a nested element. In which case the value returned by this method should be the nested element name. If more than one level of nesting is needed each nested element name should be separated by by a path separator (forward slash '/').
The location path name is "relative" to the parent Class. The name of the parent should not be included in the path.
For example, give the following two classes:
class Root { Bar bar; }
class Bar { String value; }
And the following XML:
<root> <foo> <bar> value of bar </bar> </foo> </root>
Since foo has no associated class, the path for 'bar' would be: "foo"
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| String org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getNameSpacePrefix | ( | ) |
Return the "suggested" namespace prefix to use when marshalling as XML.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| String org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getNameSpaceURI | ( | ) |
Returns the namespace URI to be used when marshalling and unmarshalling as XML.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
References org.exolab.castor.xml.NodeType.Element, and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isPrimitive().
| NodeType org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getNodeType | ( | ) |
| String org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getProperty | ( | String | propertyName | ) |
Returns the value property with the given name or null if no such property exists. This method is useful for future evolutions of this interface as well as for user-defined extensions. See class declared properties for built-in properties.
| propertyName | the name of the property whose value should be returned. |
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| String org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getQNamePrefix | ( | ) |
Returns the prefix used in case the value of the field described by this descriptor is of type QName. This is helpful for the Marshaller but not mandatory.
| String org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getSchemaType | ( | ) |
Returns the XML Schema type of the value of the field described by this descriptor.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| FieldValidator org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getValidator | ( | ) |
Returns a specific validator for the field described by this descriptor. A null value may be returned if no specific validator exists.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| String org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getXMLName | ( | ) |
Returns the XML Name for the field being described.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| int org.exolab.castor.xml.util.XMLFieldDescriptorImpl.hashCode | ( | ) |
Returns the hashCode for this XMLFieldDescriptor
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.hasNonDefaultMatching | ( | ) | [protected] |
Returns true if a call to setMatches has been made with a non-null, or non-zero-length value. This method is used by the XML Mapping Loader
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isConstructorArgument | ( | ) |
Returns true if the value of the field represented by this descriptor should be set via the constructor of the containing class. This is only valid for attribute mapped fields.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isContainer | ( | ) |
Returns true if the field described by this descriptor is a container field. A container is a field that should is not a first-class object, and should therefore have no XML representation.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isImmutable | ( | ) |
Returns true if the field type is immutable.
Implements org.exolab.castor.mapping.FieldDescriptor.
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isIncremental | ( | ) |
Returns the incremental flag which when true indicates that this member may be safely added before the unmarshaller is finished unmarshalling it.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isMapped | ( | ) |
Returns true if the field described by this descriptor is Map or Hashtable. If this method returns true, it must also return true for any call to isMultivalued.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isMultivalued | ( | ) |
Returns true if the Object described by this descriptor can contain more than one value
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isNillable | ( | ) |
Returns true if the field described by this descriptor may be nillable. A nillable field is one that may have empty content and still be valid. Please see the XML Schema 1.0 Recommendation for more information on nillable.
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| static boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isPrimitive | ( | Class | type | ) | [static, protected] |
Returns true if the given class should be treated as a primitive type. This method will return true for all Java primitive types, the set of primitive object wrappers, as well as Strings.
Referenced by org.exolab.castor.xml.util.XMLFieldDescriptorImpl.getNameSpaceURI().
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isReference | ( | ) |
Returns true if the field described by this descriptor is a reference (ie. IDREF) to another object in the "Object Model" (XML tree)
Implements org.exolab.castor.xml.XMLFieldDescriptor.
References org.exolab.castor.xml.util.XMLFieldDescriptorImpl._isReference.
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isRequired | ( | ) |
Returns true if the field described by this descriptor is a required field
Implements org.exolab.castor.mapping.FieldDescriptor.
References org.exolab.castor.xml.util.XMLFieldDescriptorImpl._required.
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isTransient | ( | ) |
Returns true if the field is transient. Transient fields are never persisted or marshalled.
Implements org.exolab.castor.mapping.FieldDescriptor.
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.matches | ( | String | xmlName, | |
| String | namespace | |||
| ) |
Returns true if this descriptor can be used to handle elements or attributes with the given XML name. By default this method simply compares the given XML name with the internal XML name. This method can be overridden to provide more complex matching.
| xmlName | the XML name to compare |
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl.matches | ( | String | xmlName | ) |
Returns true if this descriptor can be used to handle elements or attributes with the given XML name. By default this method simply compares the given XML name with the internal XML name. This method can be overridden to provide more complex matching.
| xmlName | the XML name to compare |
Implements org.exolab.castor.xml.XMLFieldDescriptor.
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setClassDescriptor | ( | XMLClassDescriptor | classDescriptor | ) |
Sets the XMLClassDescriptor for the described field
| classDescriptor | the XMLClassDescriptor for the described field. |
Referenced by org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor.ComponentBindingTypeDescriptor(), org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), org.exolab.castor.xml.Introspector.generateClassDescriptor(), and org.exolab.castor.builder.binding.PackageTypeDescriptor.PackageTypeDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setConstructorArgumentIndex | ( | int | index | ) |
Sets whether or not the value of the field represented by this FieldDescriptor should be set via the constructor of the containing ClassDescriptor. The index value greater than 0 specifies the index within the argument array that the value of this field should be.
Note: This only applies to attribute mapped fields at this time.
| index | the index within the argument array. A value less than zero indicates that this field should not be part of the constructor arguments. |
References org.exolab.castor.xml.NodeType.Attribute.
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), and org.exolab.castor.xml.descriptors.LocaleDescriptor.LocaleDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setContainer | ( | boolean | isContainer | ) |
Set if the field is a container field or not.
| isContainer | a boolean indicating whether or not the field is a container field. |
Referenced by org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor.ComponentBindingTypeDescriptor(), org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), and org.exolab.castor.builder.binding.PackageTypeDescriptor.PackageTypeDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setContainingClassDescriptor | ( | ClassDescriptor | contClsDesc | ) |
Set the class which contains this field
Implements org.exolab.castor.mapping.FieldDescriptor.
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setHandler | ( | FieldHandler | handler | ) |
Sets the FieldHandler for the field being described by this FieldDescriptor
| handler | the FieldHandler for the field being described by this FieldDescriptor |
Referenced by org.exolab.castor.builder.binding.BindingDescriptor.BindingDescriptor(), org.exolab.castor.types.CenturyDescriptor.CenturyDescriptor(), org.exolab.castor.mapping.xml.ClassMappingDescriptor.ClassMappingDescriptor(), org.exolab.castor.builder.binding.ClassTypeDescriptor.ClassTypeDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeChoiceDescriptor.ComponentBindingTypeChoiceDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor.ComponentBindingTypeDescriptor(), alma.acs.tools.comphelpergen.generated.ComponentHelperInfoDescriptor.ComponentHelperInfoDescriptor(), alma.acs.tools.comphelpergen.generated.ComponentInterfaceDescriptor.ComponentInterfaceDescriptor(), org.exolab.castor.mapping.xml.ContainerDescriptor.ContainerDescriptor(), org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), org.exolab.castor.xml.descriptors.DateClassDescriptor.DateClassDescriptor(), org.exolab.castor.types.DateDescriptor.DateDescriptor(), org.exolab.castor.types.DurationDescriptor.DurationDescriptor(), alma.tools.entitybuilder.generated.EntitybuilderSettingsDescriptor.EntitybuilderSettingsDescriptor(), alma.tools.entitybuilder.generated.EntitySchemaDescriptor.EntitySchemaDescriptor(), org.exolab.castor.xml.descriptors.EnumerationDescriptor.EnumerationDescriptor(), org.exolab.castor.mapping.xml.FieldMappingDescriptor.FieldMappingDescriptor(), org.exolab.castor.builder.binding.FieldTypeDescriptor.FieldTypeDescriptor(), org.exolab.castor.types.GDayDescriptor.GDayDescriptor(), org.exolab.castor.xml.Introspector.generateClassDescriptor(), org.exolab.castor.types.GMonthDayDescriptor.GMonthDayDescriptor(), org.exolab.castor.types.GMonthDescriptor.GMonthDescriptor(), org.exolab.castor.types.GYearDescriptor.GYearDescriptor(), org.exolab.castor.types.GYearMonthDescriptor.GYearMonthDescriptor(), org.exolab.castor.mapping.xml.IncludeDescriptor.IncludeDescriptor(), org.exolab.castor.builder.binding.IncludeTypeDescriptor.IncludeTypeDescriptor(), org.exolab.castor.builder.binding.InterfaceDescriptor.InterfaceDescriptor(), org.exolab.castor.mapping.xml.KeyGeneratorDefDescriptor.KeyGeneratorDefDescriptor(), org.exolab.castor.mapping.xml.LdapDescriptor.LdapDescriptor(), org.exolab.castor.xml.descriptors.ListClassDescriptor.ListClassDescriptor(), org.exolab.castor.xml.descriptors.LocaleDescriptor.LocaleDescriptor(), org.exolab.castor.mapping.xml.MappingRootDescriptor.MappingRootDescriptor(), org.exolab.castor.mapping.xml.MapToDescriptor.MapToDescriptor(), org.exolab.castor.types.MonthDescriptor.MonthDescriptor(), org.exolab.castor.builder.binding.NamingTypeDescriptor.NamingTypeDescriptor(), org.exolab.castor.builder.binding.NamingXMLTypeDescriptor.NamingXMLTypeDescriptor(), org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor.PackageTypeChoiceDescriptor(), org.exolab.castor.builder.binding.PackageTypeDescriptor.PackageTypeDescriptor(), org.exolab.castor.mapping.xml.ParamDescriptor.ParamDescriptor(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationDescriptor(), org.exolab.castor.xml.descriptors.RootArrayDescriptor.RootArrayDescriptor(), org.exolab.castor.xml.descriptors.SQLDateClassDescriptor.SQLDateClassDescriptor(), org.exolab.castor.xml.descriptors.SQLTimeClassDescriptor.SQLTimeClassDescriptor(), org.exolab.castor.xml.descriptors.SQLTimestampClassDescriptor.SQLTimestampClassDescriptor(), org.exolab.castor.types.TimeDescriptor.TimeDescriptor(), org.exolab.castor.types.TimeDurationDescriptor.TimeDurationDescriptor(), org.exolab.castor.types.TimePeriodDescriptor.TimePeriodDescriptor(), org.exolab.castor.xml.descriptors.VectorClassDescriptor.VectorClassDescriptor(), alma.tools.entitybuilder.generated.XmlNamespace2JPackageDescriptor.XmlNamespace2JPackageDescriptor(), and org.exolab.castor.types.YearDescriptor.YearDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setImmutable | ( | boolean | immutable | ) |
Sets the immutable flag which indicates that changes to this Field result in a new Object to be created, such as java.lang.String. It serves to identify fields which should not be constructed...until after all the data is available.
| immutable | the boolean which if true indicated that this described field is immutable |
Referenced by org.exolab.castor.builder.binding.BindingDescriptor.BindingDescriptor(), org.exolab.castor.mapping.xml.ClassMappingDescriptor.ClassMappingDescriptor(), org.exolab.castor.builder.binding.ClassTypeDescriptor.ClassTypeDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor.ComponentBindingTypeDescriptor(), alma.acs.tools.comphelpergen.generated.ComponentHelperInfoDescriptor.ComponentHelperInfoDescriptor(), alma.acs.tools.comphelpergen.generated.ComponentInterfaceDescriptor.ComponentInterfaceDescriptor(), org.exolab.castor.mapping.xml.ContainerDescriptor.ContainerDescriptor(), org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), org.exolab.castor.xml.descriptors.DateClassDescriptor.DateClassDescriptor(), alma.tools.entitybuilder.generated.EntitySchemaDescriptor.EntitySchemaDescriptor(), org.exolab.castor.mapping.xml.FieldMappingDescriptor.FieldMappingDescriptor(), org.exolab.castor.builder.binding.FieldTypeDescriptor.FieldTypeDescriptor(), org.exolab.castor.xml.Introspector.generateClassDescriptor(), org.exolab.castor.mapping.xml.IncludeDescriptor.IncludeDescriptor(), org.exolab.castor.builder.binding.InterfaceDescriptor.InterfaceDescriptor(), org.exolab.castor.mapping.xml.KeyGeneratorDefDescriptor.KeyGeneratorDefDescriptor(), org.exolab.castor.mapping.xml.MappingRootDescriptor.MappingRootDescriptor(), org.exolab.castor.mapping.xml.MapToDescriptor.MapToDescriptor(), org.exolab.castor.builder.binding.NamingTypeDescriptor.NamingTypeDescriptor(), org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor.PackageTypeChoiceDescriptor(), org.exolab.castor.builder.binding.PackageTypeDescriptor.PackageTypeDescriptor(), org.exolab.castor.mapping.xml.ParamDescriptor.ParamDescriptor(), org.exolab.castor.xml.descriptors.SQLDateClassDescriptor.SQLDateClassDescriptor(), org.exolab.castor.xml.descriptors.SQLTimeClassDescriptor.SQLTimeClassDescriptor(), org.exolab.castor.xml.descriptors.SQLTimestampClassDescriptor.SQLTimestampClassDescriptor(), and alma.tools.entitybuilder.generated.XmlNamespace2JPackageDescriptor.XmlNamespace2JPackageDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setIncremental | ( | boolean | incremental | ) |
Sets the incremental flag which indicates whether this member can be added before the unmarshaller is finished unmarshalling it.
| incremental | the boolean which if true indicated that this member can safely be added before the unmarshaller is finished unmarshalling it. |
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setLocationPath | ( | String | path | ) |
Sets the location path for the field being described.
In most cases, this isn't needed. However sometimes a field may be mapped to a nested element. In which case the value of the location path should be the nested element name. If more than one level of nesting is needed each nested element name should be separated by by a path separator (forward slash '/').
The location path name is "relative" to the parent Class. The name of the parent should not be included in the path.
For example, give the following two classes:
class Root { Bar bar; }
class Bar { String value; }
And the following XML:
<root> <foo> <bar> value of bar </bar> </foo> </root>
Since foo has no associated class, the path for 'bar' would be: "foo"
| path | the "relative" location path for the field. |
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setMapped | ( | boolean | mapped | ) |
Sets whether or not this field has been mapped in a Map or Hashtable.
| mapped | a boolean that when true indicates this field is a Hashtable or Map. |
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setMatches | ( | String | matchExpr | ) |
This is a space separated list of xml names that this Field descriptor matches. A '*' is wild.
| matchExpr | the space separated list of xml names, matched by this descriptor |
References org.exolab.castor.util.List.add(), org.exolab.castor.util.List.size(), and org.exolab.castor.util.List.toArray().
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), org.exolab.castor.mapping.xml.FieldMappingDescriptor.FieldMappingDescriptor(), org.exolab.castor.xml.Introspector.generateClassDescriptor(), org.exolab.castor.xml.descriptors.ListClassDescriptor.ListClassDescriptor(), and org.exolab.castor.xml.descriptors.VectorClassDescriptor.VectorClassDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setMultivalued | ( | boolean | multivalued | ) |
Referenced by org.exolab.castor.builder.binding.BindingDescriptor.BindingDescriptor(), org.exolab.castor.mapping.xml.ClassMappingDescriptor.ClassMappingDescriptor(), org.exolab.castor.builder.binding.ClassTypeDescriptor.ClassTypeDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeChoiceDescriptor.ComponentBindingTypeChoiceDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor.ComponentBindingTypeDescriptor(), alma.acs.tools.comphelpergen.generated.ComponentHelperInfoDescriptor.ComponentHelperInfoDescriptor(), org.exolab.castor.mapping.xml.ContainerDescriptor.ContainerDescriptor(), alma.tools.entitybuilder.generated.EntitybuilderSettingsDescriptor.EntitybuilderSettingsDescriptor(), org.exolab.castor.xml.descriptors.EnumerationDescriptor.EnumerationDescriptor(), org.exolab.castor.mapping.xml.FieldMappingDescriptor.FieldMappingDescriptor(), org.exolab.castor.xml.Introspector.generateClassDescriptor(), org.exolab.castor.mapping.xml.KeyGeneratorDefDescriptor.KeyGeneratorDefDescriptor(), org.exolab.castor.xml.descriptors.ListClassDescriptor.ListClassDescriptor(), org.exolab.castor.mapping.xml.MappingRootDescriptor.MappingRootDescriptor(), org.exolab.castor.builder.binding.NamingTypeDescriptor.NamingTypeDescriptor(), org.exolab.castor.builder.binding.NamingXMLTypeDescriptor.NamingXMLTypeDescriptor(), org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor.PackageTypeChoiceDescriptor(), org.exolab.castor.builder.binding.PackageTypeDescriptor.PackageTypeDescriptor(), org.exolab.castor.xml.descriptors.RootArrayDescriptor.RootArrayDescriptor(), and org.exolab.castor.xml.descriptors.VectorClassDescriptor.VectorClassDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setNameSpacePrefix | ( | String | nsPrefix | ) |
Sets the namespace prefix used when marshalling as XML.
| nsPrefix | the namespace prefix used when marshalling the "described" object |
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setNameSpaceURI | ( | String | nsURI | ) |
Sets the namespace URI used when marshalling and unmarshalling as XML.
| nsURI | the namespace URI used when marshalling and unmarshalling the "described" Object. |
Referenced by org.exolab.castor.builder.binding.BindingDescriptor.BindingDescriptor(), org.exolab.castor.mapping.xml.ClassMappingDescriptor.ClassMappingDescriptor(), org.exolab.castor.builder.binding.ClassTypeDescriptor.ClassTypeDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeChoiceDescriptor.ComponentBindingTypeChoiceDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor.ComponentBindingTypeDescriptor(), org.exolab.castor.mapping.xml.ContainerDescriptor.ContainerDescriptor(), org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), org.exolab.castor.mapping.xml.FieldMappingDescriptor.FieldMappingDescriptor(), org.exolab.castor.mapping.xml.IncludeDescriptor.IncludeDescriptor(), org.exolab.castor.mapping.xml.KeyGeneratorDefDescriptor.KeyGeneratorDefDescriptor(), org.exolab.castor.mapping.xml.LdapDescriptor.LdapDescriptor(), org.exolab.castor.mapping.xml.MappingRootDescriptor.MappingRootDescriptor(), org.exolab.castor.mapping.xml.MapToDescriptor.MapToDescriptor(), org.exolab.castor.builder.binding.NamingTypeDescriptor.NamingTypeDescriptor(), org.exolab.castor.builder.binding.NamingXMLTypeDescriptor.NamingXMLTypeDescriptor(), org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor.PackageTypeChoiceDescriptor(), org.exolab.castor.builder.binding.PackageTypeDescriptor.PackageTypeDescriptor(), and org.exolab.castor.mapping.xml.ParamDescriptor.ParamDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setNillable | ( | boolean | nillable | ) |
Sets whether or not the described field is allowed to be nil. A nillable field can have empty content (text or element content), but may have attribute values, and still be considered value, even if the child elements are required.
| nillable | a boolean indicating whether or not the described field may be nillable. |
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setNodeType | ( | NodeType | nodeType | ) |
Sets the XML node type for the described field
| nodeType | the NodeType for the described field |
References org.exolab.castor.xml.NodeType.Attribute.
Referenced by org.exolab.castor.xml.Introspector.generateClassDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setProperty | ( | String | propertyName, | |
| String | value | |||
| ) |
Sets the value property with the given name
| propertyName | the name of the property to set the value of | |
| value | the value of the property |
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setQNamePrefix | ( | String | qNamePrefix | ) |
Sets the prefix used in case the value of the field described by this descriptor is of type QName.
| qNamePrefix |
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setReference | ( | boolean | isReference | ) |
Sets the flag indicating that the field described by this descriptor is a reference to another field in the object model.
| isReference,true | if the field is a reference to another field. |
References org.exolab.castor.xml.util.XMLFieldDescriptorImpl._isReference.
Referenced by org.exolab.castor.mapping.xml.ClassMappingDescriptor.ClassMappingDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setRequired | ( | boolean | required | ) |
Sets the whether or not the described field is required
| required | the flag indicating whether or not the described field is required |
References org.exolab.castor.xml.util.XMLFieldDescriptorImpl._required.
Referenced by org.exolab.castor.mapping.xml.ClassMappingDescriptor.ClassMappingDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeChoiceDescriptor.ComponentBindingTypeChoiceDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor.ComponentBindingTypeDescriptor(), alma.acs.tools.comphelpergen.generated.ComponentHelperInfoDescriptor.ComponentHelperInfoDescriptor(), alma.acs.tools.comphelpergen.generated.ComponentInterfaceDescriptor.ComponentInterfaceDescriptor(), org.exolab.castor.mapping.xml.ContainerDescriptor.ContainerDescriptor(), alma.tools.entitybuilder.generated.EntitybuilderSettingsDescriptor.EntitybuilderSettingsDescriptor(), alma.tools.entitybuilder.generated.EntitySchemaDescriptor.EntitySchemaDescriptor(), org.exolab.castor.mapping.xml.FieldMappingDescriptor.FieldMappingDescriptor(), org.exolab.castor.mapping.xml.IncludeDescriptor.IncludeDescriptor(), org.exolab.castor.builder.binding.IncludeTypeDescriptor.IncludeTypeDescriptor(), org.exolab.castor.builder.binding.InterfaceDescriptor.InterfaceDescriptor(), org.exolab.castor.mapping.xml.KeyGeneratorDefDescriptor.KeyGeneratorDefDescriptor(), org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor.PackageTypeChoiceDescriptor(), org.exolab.castor.builder.binding.PackageTypeDescriptor.PackageTypeDescriptor(), and org.exolab.castor.mapping.xml.ParamDescriptor.ParamDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setSchemaType | ( | String | schemaType | ) |
Sets the type of the XML Schema type of the value for the field being described.
| type | the value type. |
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setTransient | ( | boolean | isTransient | ) |
Sets whether or not the describled field is transient
| isTransient | the flag indicating whether or not the described field is "transient". |
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setUseParentsNamespace | ( | boolean | useParentsNamespace | ) |
Sets whether or not the namespace for the parent "containing" class should be used during marshalling/unmarshalling when no specific namespace URI has been set for this field.
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setValidator | ( | FieldValidator | validator | ) |
References org.exolab.castor.xml.FieldValidator.setDescriptor().
Referenced by org.exolab.castor.builder.binding.BindingDescriptor.BindingDescriptor(), org.exolab.castor.mapping.xml.ClassMappingDescriptor.ClassMappingDescriptor(), org.exolab.castor.builder.binding.ClassTypeDescriptor.ClassTypeDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeChoiceDescriptor.ComponentBindingTypeChoiceDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor.ComponentBindingTypeDescriptor(), alma.acs.tools.comphelpergen.generated.ComponentHelperInfoDescriptor.ComponentHelperInfoDescriptor(), alma.acs.tools.comphelpergen.generated.ComponentInterfaceDescriptor.ComponentInterfaceDescriptor(), org.exolab.castor.mapping.xml.ContainerDescriptor.ContainerDescriptor(), org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), alma.tools.entitybuilder.generated.EntitybuilderSettingsDescriptor.EntitybuilderSettingsDescriptor(), alma.tools.entitybuilder.generated.EntitySchemaDescriptor.EntitySchemaDescriptor(), org.exolab.castor.mapping.xml.FieldMappingDescriptor.FieldMappingDescriptor(), org.exolab.castor.builder.binding.FieldTypeDescriptor.FieldTypeDescriptor(), org.exolab.castor.mapping.xml.IncludeDescriptor.IncludeDescriptor(), org.exolab.castor.builder.binding.IncludeTypeDescriptor.IncludeTypeDescriptor(), org.exolab.castor.builder.binding.InterfaceDescriptor.InterfaceDescriptor(), org.exolab.castor.mapping.xml.KeyGeneratorDefDescriptor.KeyGeneratorDefDescriptor(), org.exolab.castor.mapping.xml.LdapDescriptor.LdapDescriptor(), org.exolab.castor.mapping.xml.MappingRootDescriptor.MappingRootDescriptor(), org.exolab.castor.mapping.xml.MapToDescriptor.MapToDescriptor(), org.exolab.castor.builder.binding.NamingTypeDescriptor.NamingTypeDescriptor(), org.exolab.castor.builder.binding.NamingXMLTypeDescriptor.NamingXMLTypeDescriptor(), org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor.PackageTypeChoiceDescriptor(), org.exolab.castor.builder.binding.PackageTypeDescriptor.PackageTypeDescriptor(), org.exolab.castor.mapping.xml.ParamDescriptor.ParamDescriptor(), and alma.tools.entitybuilder.generated.XmlNamespace2JPackageDescriptor.XmlNamespace2JPackageDescriptor().
| void org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setXMLName | ( | String | xmlName | ) |
Sets the xml name for the described field
| name | the XML name for the described field |
Referenced by org.exolab.castor.xml.XMLMappingLoader.createFieldDesc(), org.exolab.castor.xml.Introspector.generateClassDescriptor(), org.exolab.castor.xml.descriptors.VectorClassDescriptor.setXMLName(), org.exolab.castor.xml.descriptors.ListClassDescriptor.setXMLName(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
| String org.exolab.castor.xml.util.XMLFieldDescriptorImpl.toString | ( | ) |
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl._isReference = false |
True if the field is a reference to another Object in the hierarchy.
Referenced by org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isReference(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setReference().
| boolean org.exolab.castor.xml.util.XMLFieldDescriptorImpl._required = false |
indicates a required field when true
Referenced by org.exolab.castor.xml.util.XMLFieldDescriptorImpl.isRequired(), org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setRequired(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.XMLFieldDescriptorImpl().
1.7.0
