er.ajax.json.serializer

Class EOEnterpriseObjectSerializer

java.lang.Object

org.jabsorb.serializer.AbstractSerializer

er.ajax.json.serializer.EOEnterpriseObjectSerializer

All Implemented Interfaces:

Serializable, org.jabsorb.serializer.Serializer

public class EOEnterpriseObjectSerializer
extends org.jabsorb.serializer.AbstractSerializer

La classe EOEnterpriseObjectSerializer s'occupe de la conversion des objets paramêtres de type EOEnterpriseObject entre le monde Javascript et le monde Java.

See Also:

Serialized Form

Author:

john, Jean-François Veillette

Properties

Name	Description
er.ajax.json.EOEditingContextFactory	er.ajax.json.EOEditingContextFactory
er.ajax.json.[entityName].canInsert	er.ajax.json.[entityName].canInsert
er.ajax.json.[currentEntity.name].attributes	er.ajax.json.[currentEntity.name].attributes
er.ajax.json.[currentEntity.name].writableAttributes	er.ajax.json.[currentEntity.name].writableAttributes
er.ajax.json.[currentEntity.name]relationships	er.ajax.json.[currentEntity.name]relationships

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EOEnterpriseObjectSerializer.EOEditingContextFactory
static class	EOEnterpriseObjectSerializer.ERXECEditingContextFactory
static class	EOEnterpriseObjectSerializer.SadEditingContextFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected static NSMutableDictionary<String,NSArray<String>>	includedRelationshipNames
protected static NSMutableDictionary<String,NSArray<String>>	readableAttributeNames
protected static NSMutableDictionary<String,NSArray<String>>	writableAttributeNames

Fields inherited from class org.jabsorb.serializer.AbstractSerializer

ser

Constructor Summary

Constructors

Constructor and Description
EOEnterpriseObjectSerializer()

Method Summary

Modifier and Type	Method and Description
protected void	_addCustomAttributes(org.jabsorb.serializer.SerializerState state, EOEnterpriseObject source, org.json.JSONObject destination)
protected boolean	_canInsert(String entityName) Override to return whether or not a new entity can be inserted.
protected boolean	_canSerialize(Class clazz, Class jsonClazz)
protected NSArray<String>	_includedRelationshipNames(EOEnterpriseObject eo) Override to return the appropriate relationship names.
protected NSArray<String>	_readableAttributeNames(EOEnterpriseObject eo) Override to return the appropriate attribute names.
protected NSArray<String>	_writableAttributeNames(EOEnterpriseObject eo) Override to return the appropriate attribute names.
void	addAttributes(org.jabsorb.serializer.SerializerState state, EOEnterpriseObject source, org.json.JSONObject destination) This copies the attributes from the source EOEnterpriseObject to the destination.
boolean	canSerialize(Class clazz, Class jsonClazz)
static Map<EOEditingContext,String>	contexts()
static EOEditingContext	editingContextForKey(String key)
Class[]	getJSONClasses()
Class[]	getSerializableClasses()
static NSArray<String>	includedRelationshipNames(EOEnterpriseObject source) Returns an array of relationships on this EO that should be included in its marshalled output as the actual destination objects rather than just faults.
Object	marshall(org.jabsorb.serializer.SerializerState state, Object p, Object o)
static NSArray<String>	readableAttributeNames(EOEnterpriseObject source) Returns an array of attribute names from the EOEntity of source that should be marshalled to the client.
static String	registerEditingContext(EOEditingContext ec)
org.jabsorb.serializer.ObjectMatch	tryUnmarshall(org.jabsorb.serializer.SerializerState state, Class clazz, Object jso)
Object	unmarshall(org.jabsorb.serializer.SerializerState state, Class clazz, Object o)
static NSArray<String>	writableAttributeNames(EOEnterpriseObject source) Returns an array of attribute names from the EOEntity of source that should be marshalled from the client.

Methods inherited from class org.jabsorb.serializer.AbstractSerializer

setOwner

Methods inherited from class java.lang.Object

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

Field Detail

readableAttributeNames

protected static final NSMutableDictionary<String,NSArray<String>> readableAttributeNames

writableAttributeNames

protected static final NSMutableDictionary<String,NSArray<String>> writableAttributeNames

includedRelationshipNames

protected static final NSMutableDictionary<String,NSArray<String>> includedRelationshipNames

Constructor Detail

EOEnterpriseObjectSerializer

public EOEnterpriseObjectSerializer()

Method Detail

getSerializableClasses

public Class[] getSerializableClasses()

getJSONClasses

public Class[] getJSONClasses()

_canSerialize

protected boolean _canSerialize(Class clazz,
                                Class jsonClazz)

canSerialize

public boolean canSerialize(Class clazz,
                            Class jsonClazz)

Specified by:

canSerialize in interface org.jabsorb.serializer.Serializer

Overrides:

canSerialize in class org.jabsorb.serializer.AbstractSerializer

tryUnmarshall

public org.jabsorb.serializer.ObjectMatch tryUnmarshall(org.jabsorb.serializer.SerializerState state,
                                                        Class clazz,
                                                        Object jso)

unmarshall

public Object unmarshall(org.jabsorb.serializer.SerializerState state,
                         Class clazz,
                         Object o)
                  throws org.jabsorb.serializer.UnmarshallException

Throws:

org.jabsorb.serializer.UnmarshallException

marshall

public Object marshall(org.jabsorb.serializer.SerializerState state,
                       Object p,
                       Object o)
                throws org.jabsorb.serializer.MarshallException

Throws:

org.jabsorb.serializer.MarshallException

addAttributes

public void addAttributes(org.jabsorb.serializer.SerializerState state,
                          EOEnterpriseObject source,
                          org.json.JSONObject destination)
                   throws org.jabsorb.serializer.MarshallException

This copies the attributes from the source EOEnterpriseObject to the destination. Only attributes which are class properties are copied. However if an attribute is a class property and also used in a relationship it is assumed to be an exposed primary or foreign key and not copied. Such attributes are set to null. See exposedKeyAttributeNames for details on how this is determined. It can be used when creating custom implementations of the duplicate() method in EOCopyable.

Parameters:

state - object that holds the sate of the serialization

source - the EOEnterpriseObject to copy attribute values from

destination - the EOEnterpriseObject to copy attribute values to

Throws:

org.jabsorb.serializer.MarshallException - if conversion failed

_addCustomAttributes

protected void _addCustomAttributes(org.jabsorb.serializer.SerializerState state,
                                    EOEnterpriseObject source,
                                    org.json.JSONObject destination)
                             throws org.jabsorb.serializer.MarshallException

Throws:

org.jabsorb.serializer.MarshallException

_canInsert

protected boolean _canInsert(String entityName)

Override to return whether or not a new entity can be inserted.

Parameters:

entityName - name of an entity

Returns:

true if entity is insertable

_readableAttributeNames

protected NSArray<String> _readableAttributeNames(EOEnterpriseObject eo)

Override to return the appropriate attribute names.

Parameters:

eo - enterprise object

Returns:

array of attribute names

_writableAttributeNames

protected NSArray<String> _writableAttributeNames(EOEnterpriseObject eo)

Override to return the appropriate attribute names.

Parameters:

eo - enterprise object

Returns:

array of attribute names

_includedRelationshipNames

protected NSArray<String> _includedRelationshipNames(EOEnterpriseObject eo)

Override to return the appropriate relationship names.

Parameters:

eo - enterprise object

Returns:

array of relationship names

readableAttributeNames

public static NSArray<String> readableAttributeNames(EOEnterpriseObject source)

Returns an array of attribute names from the EOEntity of source that should be marshalled to the client.

Parameters:

source - the EOEnterpriseObject to copy attribute values from

Returns:

an array of attribute names from the EOEntity of source that should be marshalled

writableAttributeNames

public static NSArray<String> writableAttributeNames(EOEnterpriseObject source)

Returns an array of attribute names from the EOEntity of source that should be marshalled from the client.

Parameters:

source - the EOEnterpriseObject

Returns:

an array of attribute names from the EOEntity of source that should be unmarshalled

includedRelationshipNames

public static NSArray<String> includedRelationshipNames(EOEnterpriseObject source)

Returns an array of relationships on this EO that should be included in its marshalled output as the actual destination objects rather than just faults.

Parameters:

source - the EOEnterpriseObject being marhsalled

Returns:

an array of relationships that should be included in the marshalling

contexts

public static Map<EOEditingContext,String> contexts()

registerEditingContext

public static String registerEditingContext(EOEditingContext ec)

editingContextForKey

public static EOEditingContext editingContextForKey(String key)