oracle.adfdt.view.common.binding.creator.v2

Class CreatorParams<O extends PatternOptions>

java.lang.Object

oracle.adfdt.view.common.binding.creator.v2.CreatorParams<O>

Direct Known Subclasses:

BinderParams

public class CreatorParams<O extends PatternOptions>
extends java.lang.Object

A set of parameters that are used during a create operation.

Constructor Summary

Constructors

Constructor and Description
CreatorParams(ADFDesignTimeContext dtContext, CreationContext creationContext, ModelProvider modelProvider, org.w3c.dom.Node insertionSubtreeRoot, java.util.Map<java.lang.String,java.lang.Object> properties) Creates the CreatorParams with a common set of parameters.

Method Summary

Modifier and Type	Method and Description
void	addProperty(java.lang.String key, java.lang.Object value) Adds a new property.
CreationContext	getCreationContext() The creation context, that should be the same instance during a single create or rebind operation.
ADFDesignTimeContext	getDtContext() The environmental context.
ModelProvider	getModelProvider() The model provider for the pattern.
O	getOptions() Returns the current PatternOptions used for the rebind.
org.w3c.dom.Document	getOwnerDocument() The source document where the nodes will be inserted eventually.
ModelProvider	getParentModelProvider() A parent model provider, if the current model provider needs to be configured further.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() The set of properties used for the create or bind operation.
org.w3c.dom.Node	getRootSubTree() The root of the subtree where the nodes will get added by default, or the root of the subtree that is parenting the nodes that will be bound.
void	mergeProperties(java.util.Map<java.lang.String,java.lang.Object> properties) Merges all properties of the given map.
void	setOptions(O options) Sets a PatternOptions to guide rebinding.
void	setParentModelProvider(ModelProvider parentModelProvider)
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> properties) Sets the properties to the given map.
void	setRootSubTree(org.w3c.dom.Node rootSubTree)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreatorParams

public CreatorParams(ADFDesignTimeContext dtContext,
                     CreationContext creationContext,
                     ModelProvider modelProvider,
                     org.w3c.dom.Node insertionSubtreeRoot,
                     java.util.Map<java.lang.String,java.lang.Object> properties)

Creates the CreatorParams with a common set of parameters. Of these, dtContext, creationContext, modelProvider, and the insertionSubTree are required.

Parameters:

dtContext - design time context

creationContext - creation context

modelProvider - model provider

insertionSubtreeRoot - insertion subtree root

properties - map of properties

Method Detail

getDtContext

public ADFDesignTimeContext getDtContext()

The environmental context.

Returns:

design time context

getCreationContext

public CreationContext getCreationContext()

The creation context, that should be the same instance during a single create or rebind operation.

Returns:

creation context

getModelProvider

public ModelProvider getModelProvider()

The model provider for the pattern.

Returns:

model provider

getRootSubTree

public org.w3c.dom.Node getRootSubTree()

The root of the subtree where the nodes will get added by default, or the root of the subtree that is parenting the nodes that will be bound.

Returns:

root subtree

setRootSubTree

public void setRootSubTree(org.w3c.dom.Node rootSubTree)

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

The source document where the nodes will be inserted eventually.

Returns:

owner document

getParentModelProvider

public ModelProvider getParentModelProvider()

A parent model provider, if the current model provider needs to be configured further. This is used for creator delegation, forwarding, and insertion.

Returns:

parent model provider

setParentModelProvider

public void setParentModelProvider(ModelProvider parentModelProvider)

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

The set of properties used for the create or bind operation.

Returns:

map of properties

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

Sets the properties to the given map. The map is live (that is the contents are not copied) unless setProperties(.), addProperty(.), or mergePropertieS(.) is called again.

Parameters:

properties - map of properties

addProperty

public void addProperty(java.lang.String key,
                        java.lang.Object value)

Adds a new property. If there are no existing properties, this will create a new properties map, then add the new property. If properties exist, this will create a new properties map with values from the old properties map, then add the property. For this reason, if you know you are working with a mutable properties map (i.e. you passed it in), it is preferrable to fetch that map (see getProperties(.)), and then add properties directly to that.

Parameters:

key - property key

value - property value

mergeProperties

public void mergeProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

Merges all properties of the given map. If there are no existing properties, this will create a new properties map, then merge into that. If properties exist, this will create a new properties map with values from the old properties map, then merge the properties. For this reason, if you know you are working with a mutable properties map (i.e. you passed it in), it is preferrable to fetch that map (see getProperties(.)), and then add properties directly to that.

Parameters:

properties - map of properties

setOptions

public void setOptions(O options)

Sets a PatternOptions to guide rebinding.

Parameters:

options - pattern options

getOptions

public O getOptions()

Returns the current PatternOptions used for the rebind.

Returns:

pattern options