er.rest

Class ERXRestRequestNode

java.lang.Object

er.rest.ERXRestRequestNode

All Implemented Interfaces:

com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCodingAdditions

public class ERXRestRequestNode
extends Object
implements com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCodingAdditions

ERXRestRequestNode provides a model of a REST request. Because the incoming document format can vary (XML, JSON, etc), we needed a document model that is more abstract than just an org.w3c.dom. Or, rather, one that isn't obnoxious to use.

Author:

mschrag

Properties

Name	Description
ERXRest.includeNullValues	Boolean property to enable null values in return. Defaults to true.

Nested Class Summary

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.MapImplementation, com.webobjects.foundation.NSKeyValueCoding.Null<T>, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

Field Summary

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Constructor Summary

Constructors

Constructor and Description
ERXRestRequestNode() Constructs a new root node with no name.
ERXRestRequestNode(String name, boolean rootNode) Construct a node with the given name
ERXRestRequestNode(String name, Object value, boolean rootNode) Construct a node with the given name and value.

Method Summary

Modifier and Type	Method and Description
protected void	_addAttributeNodeForKeyInObject(ERXKey<?> key, Object obj, ERXKeyFilter keyFilter)
protected void	_addAttributesAndRelationshipsForObjectOfEntity(Object obj, com.webobjects.eocontrol.EOClassDescription classDescription, ERXKeyFilter keyFilter, ERXRestContext context, Set<Object> visitedObjects)
protected void	_addToManyRelationshipNodeForKeyOfEntityInObject(ERXKey<?> key, com.webobjects.eocontrol.EOClassDescription destinationEntity, Object obj, ERXKeyFilter keyFilter, ERXRestContext context, Set<Object> visitedObjects)
protected void	_addToOneRelationshipNodeForKeyInObject(ERXKey<?> key, Object obj, com.webobjects.eocontrol.EOClassDescription destinationEntity, ERXKeyFilter keyFilter, ERXRestContext context, Set<Object> visitedObjects)
protected void	_fillInWithObjectAndFilter(Object obj, com.webobjects.eocontrol.EOClassDescription classDescription, ERXKeyFilter keyFilter, ERXRestContext context, Set<Object> visitedObjects)
void	_removeRedundantTypes()
protected void	_safeDidSkipValueForKey(ERXKeyFilter keyFilter, Object target, Object value, String key)
protected void	_safeDidTakeValueForKey(ERXKeyFilter keyFilter, Object target, Object value, String key)
protected void	_safeWillTakeValueForKey(ERXKeyFilter keyFilter, Object target, Object value, String key)
void	addChild(ERXRestRequestNode child) Adds a child to this node.
Object	associatedObject() Returns the original object associated with this node.
Object	attributeForKey(String key) Returns the attribute value for the given key.
Object	attributeOrChildNodeValue(String name) Returns the type of this node.
Map<String,Object>	attributes() Returns the attributes dictionary for this node.
ERXRestRequestNode	childAtIndex(int index)
ERXRestRequestNode	childNamed(String name) Returns the first child named 'name'.
NSArray<ERXRestRequestNode>	children() Returns the children of this node.
ERXRestRequestNode	cloneNode() Clones this node.
Object	createObject() Equivalent to createObjectWithFilter(null, ERXKeyFilter.filterWithAllRecursive(), new ERXRestContext());
Object	createObjectWithFilter(String entityName, ERXKeyFilter keyFilter, ERXRestContext context) Creates a new instance of an object represented by this request node.
protected String	entityName(String suggestedEntityName)
protected void	guessNull()
Object	id() Returns the ID associated with this node.
boolean	isArray() Return whether or not this node represents an array or to-many relationship.
protected boolean	isClassProperty(com.webobjects.eocontrol.EOClassDescription classDescription, String key)
boolean	isNull() Returns whether or not this node represents a null value.
boolean	isRootNode() Returns whether or not this is a root node (a root node is one that would typically have a node name that is an entity name -- the actual root, or elements in an array, for instance).
String	name() Returns the name of this node.
Object	object() Equivalent to objectWithFilter(null, ERXKeyFilter.filterWithAllRecursive(), new ERXRestContext());
Object	objectWithFilter(String entityName, ERXKeyFilter keyFilter, ERXRestContext context) Returns the object that this request node represents.
Object	removeAttributeForKey(String key) Removes the attribute that has the given name.
Object	removeAttributeOrChildNodeNamed(String name) Removes the attribute or child node that has the given name (and returns it).
ERXRestRequestNode	removeChildNamed(String name) Removes the child name that has the given name.
static ERXRestRequestNode	requestNodeWithObjectAndFilter(com.webobjects.eocontrol.EOClassDescription classDescription, List<?> objects, ERXKeyFilter keyFilter, ERXRestContext context) Creates a hierarchy of ERXRestRequestNodes based off of the given array of objects.
static ERXRestRequestNode	requestNodeWithObjectAndFilter(Object obj, ERXKeyFilter keyFilter, ERXRestContext context) Creates a hierarchy of ERXRestRequestNodes based off of the given object.
void	setArray(boolean array) Sets whether or not this node represents an array or to-many relationship.
void	setAssociatedObject(Object associatedObject) Sets the original object associated with this node.
void	setAttributeForKey(Object attribute, String key) Sets the attribute value for the given key.
void	setID(Object id) Sets the ID associated with this node.
void	setName(String name) Sets the name of this node.
void	setNull(boolean isNull) Sets whether or not this node represents a null value.
void	setRootNode(boolean rootNode) Sets whether or not this is a root node (a root node is one that would typically have a node name that is an entity name -- the actual root, or elements in an array, for instance).
void	setType(String type) Sets the type of this node (type as in the Class that it represents).
void	setValue(Object value) Sets the value for this node.
void	takeValueForKey(Object value, String keyName)
void	takeValueForKeyPath(Object value, String keyPath)
Object	toJavaCollection(ERXRestFormat.Delegate delegate) Returns the Java object that corresponds to this node hierarchy.
Object	toJavaCollection(ERXRestFormat.Delegate delegate, Map<Object,ERXRestRequestNode> conversionMap) Returns the Java object that corresponds to this node hierarchy.
protected Object	toJavaCollection(ERXRestFormat.Delegate delegate, Map<Object,ERXRestRequestNode> conversionMap, Map<Object,Object> associatedObjects) Returns the Java object that corresponds to this node hierarchy.
Object	toNSCollection(ERXRestFormat.Delegate delegate) Returns the NSCollection/Java object that corresponds to this node hierarchy.
protected Object	toNSCollection(ERXRestFormat.Delegate delegate, NSMutableDictionary<Object,Object> associatedObjects) Returns the NSCollection/Java object that corresponds to this node hierarchy.
String	toString()
String	toString(ERXRestFormat format, ERXRestContext context) Returns a string representation of this request node using the given format.
String	toString(IERXRestWriter writer, ERXRestFormat.Delegate delegate, ERXRestContext context) Returns a string representation of this request node using the given IERXRestWriter.
protected void	toString(StringBuffer sb, int depth)
String	type() Returns the type of this node (type as in the Class that it represents).
void	updateObject(Object obj) Equivalent to updateObjectWithFilter(obj, ERXKeyFilter.filterWithAllRecursive(), new ERXRestContext());
void	updateObjectWithFilter(Object obj, ERXKeyFilter keyFilter, ERXRestContext context) Updates the given object based on this request node.
Object	value() Returns the value for this node (or null if it doesn't exist).
Object	valueForKey(String keyName)
Object	valueForKeyPath(String keyPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXRestRequestNode

public ERXRestRequestNode()

Constructs a new root node with no name.

ERXRestRequestNode

public ERXRestRequestNode(String name,
                          boolean rootNode)

Construct a node with the given name

Parameters:

name - the name of this node

rootNode - if true, the node is the root of a graph

ERXRestRequestNode

public ERXRestRequestNode(String name,
                          Object value,
                          boolean rootNode)

Construct a node with the given name and value.

Parameters:

name - the name of this node

rootNode - if true, the node is the root of a graph

value - the value of this node

Method Detail

cloneNode

public ERXRestRequestNode cloneNode()

Clones this node.

Returns:

a clone of this node

setRootNode

public void setRootNode(boolean rootNode)

Sets whether or not this is a root node (a root node is one that would typically have a node name that is an entity name -- the actual root, or elements in an array, for instance).

Parameters:

rootNode - whether or not this is a root node

isRootNode

public boolean isRootNode()

Returns whether or not this is a root node (a root node is one that would typically have a node name that is an entity name -- the actual root, or elements in an array, for instance).

Returns:

whether or not this is a root node

toJavaCollection

public Object toJavaCollection(ERXRestFormat.Delegate delegate)

Returns the Java object that corresponds to this node hierarchy.

Parameters:

delegate - the format delegate to notify during rendering

Returns:

the Java object that corresponds to this node hierarchy

toJavaCollection

public Object toJavaCollection(ERXRestFormat.Delegate delegate,
                               Map<Object,ERXRestRequestNode> conversionMap)

Returns the Java object that corresponds to this node hierarchy.

Parameters:

delegate - the format delegate to notify during rendering

conversionMap - the conversion map to use to record object => request node mappings

Returns:

the Java object that corresponds to this node hierarchy

toJavaCollection

protected Object toJavaCollection(ERXRestFormat.Delegate delegate,
                                  Map<Object,ERXRestRequestNode> conversionMap,
                                  Map<Object,Object> associatedObjects)

Returns the Java object that corresponds to this node hierarchy.

Parameters:

delegate - the format delegate to notify during rendering

conversionMap - the conversion map to use to record object => request node mappings

associatedObjects - the associatedObjects map (to prevent infinite loops)

Returns:

the Java object that corresponds to this node hierarchy

toNSCollection

public Object toNSCollection(ERXRestFormat.Delegate delegate)

Returns the NSCollection/Java object that corresponds to this node hierarchy.

Returns:

the NSCollection/Java object that corresponds to this node hierarchy

toNSCollection

protected Object toNSCollection(ERXRestFormat.Delegate delegate,
                                NSMutableDictionary<Object,Object> associatedObjects)

Returns the NSCollection/Java object that corresponds to this node hierarchy.

Parameters:

associatedObjects - the associatedObjects map (to prevent infinite loops)

Returns:

NSCollection/Java object that corresponds to this node hierarchy

setArray

public void setArray(boolean array)

Sets whether or not this node represents an array or to-many relationship.

Parameters:

array - whether or not this node represents an array or to-many relationship

isArray

public boolean isArray()

Return whether or not this node represents an array or to-many relationship.

Returns:

whether or not this node represents an array or to-many relationship

setAssociatedObject

public void setAssociatedObject(Object associatedObject)

Sets the original object associated with this node.

Parameters:

associatedObject - the original object associated with this node

associatedObject

public Object associatedObject()

Returns the original object associated with this node.

Returns:

the original object associated with this node

takeValueForKey

public void takeValueForKey(Object value,
                            String keyName)

Specified by:

takeValueForKey in interface com.webobjects.foundation.NSKeyValueCoding

valueForKey

public Object valueForKey(String keyName)

Specified by:

valueForKey in interface com.webobjects.foundation.NSKeyValueCoding

valueForKeyPath

public Object valueForKeyPath(String keyPath)

Specified by:

valueForKeyPath in interface com.webobjects.foundation.NSKeyValueCodingAdditions

takeValueForKeyPath

public void takeValueForKeyPath(Object value,
                                String keyPath)

Specified by:

takeValueForKeyPath in interface com.webobjects.foundation.NSKeyValueCodingAdditions

childAtIndex

public ERXRestRequestNode childAtIndex(int index)

childNamed

public ERXRestRequestNode childNamed(String name)

Returns the first child named 'name'.

Parameters:

name - the name to look for

Returns:

the first child with this name (or null if not found)

removeChildNamed

public ERXRestRequestNode removeChildNamed(String name)

Removes the child name that has the given name.

Parameters:

name - the name of the node to remove

Returns:

the node that was removed

setType

public void setType(String type)

Sets the type of this node (type as in the Class that it represents).

Parameters:

type - the type of this node

type

public String type()

Returns the type of this node (type as in the Class that it represents).

Returns:

the type of this node

setID

public void setID(Object id)

Sets the ID associated with this node.

Parameters:

id - the ID associated with this node

id

public Object id()

Returns the ID associated with this node.

Returns:

the ID associated with this node

removeAttributeOrChildNodeNamed

public Object removeAttributeOrChildNodeNamed(String name)

Removes the attribute or child node that has the given name (and returns it).

Parameters:

name - the name of the attribute or node to remove

Returns:

the removed attribute value

attributeOrChildNodeValue

public Object attributeOrChildNodeValue(String name)

Returns the type of this node.

Parameters:

name - the attribute or node name

Returns:

the type of this node

guessNull

protected void guessNull()

setNull

public void setNull(boolean isNull)

Sets whether or not this node represents a null value.

Parameters:

isNull - whether or not this node represents a null value

isNull

public boolean isNull()

Returns whether or not this node represents a null value.

Returns:

true whether or not this node represents a null value

name

public String name()

Returns the name of this node.

Returns:

the name of this node

setName

public void setName(String name)

Sets the name of this node.

Parameters:

name - the name of this node

value

public Object value()

Returns the value for this node (or null if it doesn't exist).

Returns:

the name of this node

setValue

public void setValue(Object value)

Sets the value for this node.

Parameters:

value - the value for this node

setAttributeForKey

public void setAttributeForKey(Object attribute,
                               String key)

Sets the attribute value for the given key.

Parameters:

attribute - the attribute value

key - the key

removeAttributeForKey

public Object removeAttributeForKey(String key)

Removes the attribute that has the given name.

Parameters:

key - the name of the attribute to remove

Returns:

the attribute value

attributeForKey

public Object attributeForKey(String key)

Returns the attribute value for the given key.

Parameters:

key - the key

Returns:

the attribute value

attributes

public Map<String,Object> attributes()

Returns the attributes dictionary for this node.

Returns:

the attributes dictionary

addChild

public void addChild(ERXRestRequestNode child)

Adds a child to this node.

Parameters:

child - the child to add

children

public NSArray<ERXRestRequestNode> children()

Returns the children of this node.

Returns:

the children of this node

toString

public String toString()

Overrides:

toString in class Object

toString

protected void toString(StringBuffer sb,
                        int depth)

entityName

protected String entityName(String suggestedEntityName)

object

public Object object()

Equivalent to objectWithFilter(null, ERXKeyFilter.filterWithAllRecursive(), new ERXRestContext());

Returns:

the object that this request node represents

objectWithFilter

public Object objectWithFilter(String entityName,
                               ERXKeyFilter keyFilter,
                               ERXRestContext context)

Returns the object that this request node represents.

Parameters:

entityName - the entity name of the object to use

keyFilter - the filter to use for determining which keys can be updated (or null for no update)

context - the REST context

Returns:

the object that this request node represents

createObject

public Object createObject()

Equivalent to createObjectWithFilter(null, ERXKeyFilter.filterWithAllRecursive(), new ERXRestContext());

Returns:

a new instance of an object represented by this request node

createObjectWithFilter

public Object createObjectWithFilter(String entityName,
                                     ERXKeyFilter keyFilter,
                                     ERXRestContext context)

Creates a new instance of an object represented by this request node.

Parameters:

entityName - the entity name of the object to use

keyFilter - the filter to use for determining which keys can be updated (or null for no update)

context - the REST context

Returns:

a new instance of an object represented by this request node

_addAttributeNodeForKeyInObject

protected void _addAttributeNodeForKeyInObject(ERXKey<?> key,
                                               Object obj,
                                               ERXKeyFilter keyFilter)

_addToManyRelationshipNodeForKeyOfEntityInObject

protected void _addToManyRelationshipNodeForKeyOfEntityInObject(ERXKey<?> key,
                                                                com.webobjects.eocontrol.EOClassDescription destinationEntity,
                                                                Object obj,
                                                                ERXKeyFilter keyFilter,
                                                                ERXRestContext context,
                                                                Set<Object> visitedObjects)

_addToOneRelationshipNodeForKeyInObject

protected void _addToOneRelationshipNodeForKeyInObject(ERXKey<?> key,
                                                       Object obj,
                                                       com.webobjects.eocontrol.EOClassDescription destinationEntity,
                                                       ERXKeyFilter keyFilter,
                                                       ERXRestContext context,
                                                       Set<Object> visitedObjects)

_addAttributesAndRelationshipsForObjectOfEntity

protected void _addAttributesAndRelationshipsForObjectOfEntity(Object obj,
                                                               com.webobjects.eocontrol.EOClassDescription classDescription,
                                                               ERXKeyFilter keyFilter,
                                                               ERXRestContext context,
                                                               Set<Object> visitedObjects)

_fillInWithObjectAndFilter

protected void _fillInWithObjectAndFilter(Object obj,
                                          com.webobjects.eocontrol.EOClassDescription classDescription,
                                          ERXKeyFilter keyFilter,
                                          ERXRestContext context,
                                          Set<Object> visitedObjects)

toString

public String toString(ERXRestFormat format,
                       ERXRestContext context)

Returns a string representation of this request node using the given format.

Parameters:

format - the format to use

context - the REST context

Returns:

a string representation of this request node using the given format

toString

public String toString(IERXRestWriter writer,
                       ERXRestFormat.Delegate delegate,
                       ERXRestContext context)

Returns a string representation of this request node using the given IERXRestWriter.

Parameters:

writer - the writer to use

context - the REST context

Returns:

a string representation of this request node using the given IERXRestWriter

isClassProperty

protected boolean isClassProperty(com.webobjects.eocontrol.EOClassDescription classDescription,
                                  String key)

_safeWillTakeValueForKey

protected void _safeWillTakeValueForKey(ERXKeyFilter keyFilter,
                                        Object target,
                                        Object value,
                                        String key)

_safeDidTakeValueForKey

protected void _safeDidTakeValueForKey(ERXKeyFilter keyFilter,
                                       Object target,
                                       Object value,
                                       String key)

_safeDidSkipValueForKey

protected void _safeDidSkipValueForKey(ERXKeyFilter keyFilter,
                                       Object target,
                                       Object value,
                                       String key)

updateObject

public void updateObject(Object obj)

Equivalent to updateObjectWithFilter(obj, ERXKeyFilter.filterWithAllRecursive(), new ERXRestContext());

Parameters:

obj - the object to update

updateObjectWithFilter

public void updateObjectWithFilter(Object obj,
                                   ERXKeyFilter keyFilter,
                                   ERXRestContext context)

Updates the given object based on this request node.

Parameters:

obj - the object to update

keyFilter - the filter to use to determine how to update

context - the REST context

_removeRedundantTypes

public void _removeRedundantTypes()

requestNodeWithObjectAndFilter

public static ERXRestRequestNode requestNodeWithObjectAndFilter(com.webobjects.eocontrol.EOClassDescription classDescription,
                                                                List<?> objects,
                                                                ERXKeyFilter keyFilter,
                                                                ERXRestContext context)

Creates a hierarchy of ERXRestRequestNodes based off of the given array of objects.

Parameters:

classDescription - the entity type of the objects in the array

objects - the array to turn into request nodes

keyFilter - the filter to use

context - the REST context

Returns:

the root ERXRestRequestNode

requestNodeWithObjectAndFilter

public static ERXRestRequestNode requestNodeWithObjectAndFilter(Object obj,
                                                                ERXKeyFilter keyFilter,
                                                                ERXRestContext context)

Creates a hierarchy of ERXRestRequestNodes based off of the given object.

Parameters:

obj - the object to turn into request nodes

keyFilter - the filter to use

context - the REST context

Returns:

the root ERXRestRequestNode