EclipseLink Core 4.0.2 · org.eclipse.persistence.oxm.sequenced.Setting

Setting objects are used to control the order in which the mappings for Sequenced Objects are processed.

Example 1

Setting piSetting = new Setting(null, "personal-info");

Setting fnSetting = new Setting(null, "first-name");
piSetting.addChild(fnSetting);

Setting fnTextSetting = new Setting(null, "text()");
fnTextSetting.setObject(customerObject);
fnTextSetting.setMapping(customerFirstNameMapping);
fnTextSetting.setValue("Jane");
fnSetting.addChild(fnTextSetting);

Setting lnSetting = new Setting(null, "last-name");
piSetting.addChild(lnSetting);

Setting lnTextSetting = new Setting(null, "text()");
lnTextSetting.setObject(customerObject);
lnTextSetting.setMapping(customerLastNameMapping);
lnTextSetting.setValue("Doe");
lnSetting.getSequence().add(lnTextSetting);

<personal-info>
     <first-name>Jane</first-name>
     <last-name>Doe</last-name>
</personal-info>

Example 2

Setting fnpiSetting = new Setting(null, "personal-info");

Setting fnSetting = new Setting(null, "first-name");
fnpiSetting.addChild(fnSetting);

Setting fnTextSetting = new Setting(null, "text()");
fnTextSetting.setObject(customerObject);
fnTextSetting.setMapping(customerFirstNameMapping);
fnTextSetting.setValue("Jane");
fnSetting.addChild(fnTextSetting);

Setting lnpiSetting = new Setting(null, "personal-info");

Setting lastNameSetting = new Setting(null, "last-name");
lnpiSetting.addChild(lnSetting);

Setting lnTextSetting = new Setting(null, "text()");
lnTextSetting.setObject(customerObject);
lnTextSetting.setMapping(customerLastNameMapping);
lnTextSetting.setValue("Doe");
lnSetting.addChild(lnTextSetting);

<personal-info>
     <first-name>Jane</first-name>
</personal-info>
<personal-info>
     <last-name>Doe</last-name>
</personal-info>

Modifier and Type	Field and Description
private List<Setting>	children
private CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField>	mapping
private String	name
private String	namespaceURI
private Object	object
private Setting	parent
private Object	value

Constructor Summary

Access	Constructor and Description
public	Setting()
public	Setting(String namespaceURI, String name)

Method Summary

Modifier and Type	Method and Description
public void	addChild(Setting This setting will be added to the parent. The parenting information will be updated automatically. A child must only be added to one parent. childSetting)
public void	addValue(Object value, boolean updateObject, Object container)
public Setting	Returns: A copy of the Setting object and its child Setting objects. The copy contains references to the original object, mapping, and value. copy()
public Setting	copy(Object newParent)
public Setting	copy(Object newParent, Object copyValue)
public List<Setting>	Returns: The child Settings or null if this setting has no children. getChildren()
public CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField>	Returns: The mapping for the domain object that corresponds to this Setting. getMapping()
public String	getName() Return the name of the setting.
public String	Returns: The namespace URI that qualifies the name of the Setting (if there is one). getNamespaceURI()
public Object	Returns: The domain object to which this Setting applies. getObject()
public Setting	Returns: The parent Setting or null if this setting has not parent. getParent()
public Object	Returns: The value corresponding to this setting. getValue()
public void	setMapping(CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField> The mapping for the domain object that corresponds to this Setting. mapping)
public void	setName(String name) Specify the name of the setting.
public void	setNamespaceURI(String Specify the namespace URI that qualifies the name of the Setting (if there is one). namespaceURI)
public void	setObject(Object This is the domain object to which this Setting belongs. object)
public void	setParent(Setting The parent Setting or null if this setting has not parent. parentSetting)
public void	setValue(Object value) Set the value on the Setting.
public void	setValue(Object The value to be set on the Setting. value, boolean This flag indicates if an update is performed on the corresponding domain object using the specified mapping. updateObject)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

children	back to summary
private List<Setting> children

mapping	back to summary
private CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField> mapping

mapping

back to summary

private CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField> mapping

name	back to summary
private String name

namespaceURI	back to summary
private String namespaceURI

object	back to summary
private Object object

parent	back to summary
private Setting parent

value	back to summary
private Object value

Constructor Detail

Setting	back to summary
public Setting()

Setting	back to summary
public Setting(String namespaceURI, String name)

Method Detail

addChild	back to summary
public void addChild(Setting childSetting) Parameters childSetting:Setting This setting will be added to the parent. The parenting information will be updated automatically. A child must only be added to one parent.

addValue	back to summary
public void addValue(Object value, boolean updateObject, Object container)

copy	back to summary
public Setting copy() Returns:Setting A copy of the Setting object and its child Setting objects. The copy contains references to the original object, mapping, and value.

copy	back to summary
public Setting copy(Object newParent)

copy	back to summary
public Setting copy(Object newParent, Object copyValue)

getChildren	back to summary
public List<Setting> getChildren() Returns:List<Setting> The child Settings or null if this setting has no children.

getMapping	back to summary
public CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField> getMapping() Returns:CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField> The mapping for the domain object that corresponds to this Setting.

getMapping

back to summary

public CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField> getMapping()

Returns:CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField>: The mapping for the domain object that corresponds to this Setting.

getName	back to summary
public String getName() Return the name of the setting. The name of the setting corresponds to a fragment of an XPath in an object-to-XML mapping. Example For the XPath personal-info/first-name/text() would correspond to 3 Setting objects with names "personal-info", "first-name", and "text()"

getName

back to summary

public String getName()

Return the name of the setting. The name of the setting corresponds to a fragment of an XPath in an object-to-XML mapping.

Example

For the XPath personal-info/first-name/text() would correspond to 3 Setting objects with names "personal-info", "first-name", and "text()"

getNamespaceURI	back to summary
public String getNamespaceURI() Returns:String The namespace URI that qualifies the name of the Setting (if there is one).

getObject	back to summary
public Object getObject() Returns:Object The domain object to which this Setting applies.

getParent	back to summary
public Setting getParent() Returns:Setting The parent Setting or null if this setting has not parent.

getValue	back to summary
public Object getValue() Returns:Object The value corresponding to this setting.

setMapping	back to summary
public void setMapping(CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField> mapping) Parameters mapping:CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField> The mapping for the domain object that corresponds to this Setting.

setMapping

back to summary

public void setMapping(CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField> mapping)

Parameters

mapping:CoreMapping<ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor, ABSTRACT_SESSION extends CoreAbstractSession, CONTAINER_POLICY extends CoreContainerPolicy, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField>: The mapping for the domain object that corresponds to this Setting.

setName	back to summary
public void setName(String name) Specify the name of the setting. The name of the setting corresponds to a fragment of an XPath in an object-to-XML mapping. Example For the XPath personal-info/first-name/text() would correspond to 3 Setting objects with names "personal-info", "first-name", and "text()"

setName

back to summary

public void setName(String name)

Specify the name of the setting. The name of the setting corresponds to a fragment of an XPath in an object-to-XML mapping.

Example

For the XPath personal-info/first-name/text() would correspond to 3 Setting objects with names "personal-info", "first-name", and "text()"

setNamespaceURI	back to summary
public void setNamespaceURI(String namespaceURI) Parameters namespaceURI:String Specify the namespace URI that qualifies the name of the Setting (if there is one).

setObject	back to summary
public void setObject(Object object) Parameters object:Object This is the domain object to which this Setting belongs.

setParent	back to summary
public void setParent(Setting parentSetting) Parameters parentSetting:Setting The parent Setting or null if this setting has not parent.

setValue	back to summary
public void setValue(Object value) Set the value on the Setting. This method will also update the corresponding domain object using the specified mapping.

setValue	back to summary
public void setValue(Object value, boolean updateObject) Parameters value:Object The value to be set on the Setting. updateObject:boolean This flag indicates if an update is performed on the corresponding domain object using the specified mapping.

public Class Setting

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail