| org.compass.core.marshall.MarshallingStrategy
All known Subclasses: org.compass.core.marshall.DefaultMarshallingStrategy,
| MarshallingStrategy | | public interface MarshallingStrategy (Code) | | Responsible for marhslling and unmarashlling high level objects (a.k.a root object)
to and from
Resource .
author:
kimchy |
| Method Summary | |
| Resource | marshall(String alias, Object root)
Marshalls the given Object into a
Resource based on the
ResourceMapping associated with the provided alias. | | Resource | marshall(Object root)
Marshalls the given Object into a
Resource based on the
ResourceMapping associated with the provided object. | | Resource | marshallIds(Object id)
Marshalls the given id object into a Resource (a resource having only its ids set).
Note, that the id can be several types, depending on the mapping. | | Resource | marshallIds(String alias, Object id)
Marshalls the give id object into a Resource (a resource having only its ids set).
Note, that the id can be several types, depending on the mapping. | | Resource | marshallIds(Class clazz, Object id)
Marshalls the give id object into a Resource (a resource having only its ids set).
Note, that the id can be several types, depending on the mapping. | | Resource | marshallIds(ResourceMapping resourceMapping, Object id)
Marshalls the give id object into a Resource (a resource having only its ids set).
Note, that the id can be several types, depending on the mapping. | | boolean | marshallIds(Resource resource, ResourceMapping resourceMapping, Object id, MarshallingContext context)
Marshalls the give id object into the provided Resource (a resource having only its ids set).
Note, that the id can be several types, depending on the mapping. | | void | marshallIds(Object root, Object id)
Marhsalls the give id into the actual object. | | void | marshallIds(ResourceMapping resourceMapping, Object root, Object id)
Marhsalls the give id into the actual object. | | Object | unmarshall(Resource resource)
Unmarshalls the given resource to an Object based on the
ResourceMapping regsitered under the
Resource alias. | | Object | unmarshall(Resource resource, MarshallingContext context)
Unmarshalls the given resource to an Object based on the
ResourceMapping regsitered under the
Resource alias WITHIN the given marshalling context. | | Object[] | unmarshallIds(String alias, Object id)
Unmarshalls the given id object into an array of all the id values. | | Object[] | unmarshallIds(Class clazz, Object id)
Unmarshalls the given id object into an array of all the id values. | | Object[] | unmarshallIds(ResourceMapping resourceMapping, Object id, MarshallingContext context)
Unmarshalls the given id object into an array of all the id values. |
| marshall | | Resource marshall(String alias, Object root)(Code) | | Marshalls the given Object into a
Resource based on the
ResourceMapping associated with the provided alias. Returns null if there are no mappings.
Parameters:
alias - The alias to look up the ResourceMapping
Parameters:
root - The object to marshall into the resource The resource result of marshalling the object or null if has no mapping |
| marshallIds | | Resource marshallIds(Object id)(Code) | | Marshalls the given id object into a Resource (a resource having only its ids set).
Note, that the id can be several types, depending on the mapping. For example, for
class mapping, it can be the root Object itself (with its ids set), an array of ids,
or if a single id, the actual id object.
The
ResourceMapping are looked up based on the given object.
Will return null if no mappins are found
Parameters:
id - The id to marshall into a Resource A resource having its id properties set |
| marshallIds | | Resource marshallIds(String alias, Object id)(Code) | | Marshalls the give id object into a Resource (a resource having only its ids set).
Note, that the id can be several types, depending on the mapping. For example, for
class mapping, it can be the root Object itself (with its ids set), an array of ids,
or if a single id, the actual id object.
The
ResourceMapping are looked up based on the given alias.
Will return null if no mappins are found
Parameters:
alias - The alias to look up the ResourceMapping based
Parameters:
id - The id to marshall into a Resource A resource having its id properties set |
| marshallIds | | Resource marshallIds(Class clazz, Object id)(Code) | | Marshalls the give id object into a Resource (a resource having only its ids set).
Note, that the id can be several types, depending on the mapping. For example, for
class mapping, it can be the root Object itself (with its ids set), an array of ids,
or if a single id, the actual id object.
The
ResourceMapping are looked up based on the given class.
Will return null if no mappins are found
Parameters:
clazz - The class to look up the ResourceMapping based
Parameters:
id - The id to marshall into a Resource A resource having its id properties set |
| marshallIds | | Resource marshallIds(ResourceMapping resourceMapping, Object id)(Code) | | Marshalls the give id object into a Resource (a resource having only its ids set).
Note, that the id can be several types, depending on the mapping. For example, for
class mapping, it can be the root Object itself (with its ids set), an array of ids,
or if a single id, the actual id object.
Parameters:
resourceMapping - The resource mapping holding how to marhsall the ids
Parameters:
id - The id to marshall into a Resource A resource having its id properties set |
| marshallIds | | boolean marshallIds(Resource resource, ResourceMapping resourceMapping, Object id, MarshallingContext context)(Code) | | Marshalls the give id object into the provided Resource (a resource having only its ids set).
Note, that the id can be several types, depending on the mapping. For example, for
class mapping, it can be the root Object itself (with its ids set), an array of ids,
or if a single id, the actual id object.
Parameters:
resource - The resource to marhsll the ids into
Parameters:
resourceMapping - The resource mapping holding how to marhsall the ids
Parameters:
id - The id to marshall into a Resource true if stored properties were added to the Resource. |
| marshallIds | | void marshallIds(Object root, Object id)(Code) | | Marhsalls the give id into the actual object. Kindda hacky... .
Parameters:
root - The object to marshall the ids into
Parameters:
id - The id to marshall into the root object |
| marshallIds | | void marshallIds(ResourceMapping resourceMapping, Object root, Object id)(Code) | | Marhsalls the give id into the actual object. Kindda hacky... .
Parameters:
resourceMapping - The resource mapping for the given object
Parameters:
root - The object to marshall the ids into
Parameters:
id - The id to marshall into the root object |
| unmarshall | | Object unmarshall(Resource resource)(Code) | | Unmarshalls the given resource to an Object based on the
ResourceMapping regsitered under the
Resource alias.
Parameters:
resource - The resource to unmarshall from The object unmarshalled from the resource |
| unmarshall | | Object unmarshall(Resource resource, MarshallingContext context)(Code) | | Unmarshalls the given resource to an Object based on the
ResourceMapping regsitered under the
Resource alias WITHIN the given marshalling context.
Parameters:
resource - The resource to unmarshall from
Parameters:
context - The context to unmarshall the resource within The object unmarshalled from the resource |
| unmarshallIds | | Object[] unmarshallIds(String alias, Object id)(Code) | | Unmarshalls the given id object into an array of all the id values. The results depends
on the type of the mappings (raw resource/class).
The unmarshalling is performed based on
ResourceMapping associated with the given
alias.
Parameters:
alias - The alias to lookup the ResourceMapping
Parameters:
id - The id to unmarshall An array of all the ids |
| unmarshallIds | | Object[] unmarshallIds(Class clazz, Object id)(Code) | | Unmarshalls the given id object into an array of all the id values. The results depends
on the type of the mappings (raw resource/class).
The unmarshalling is performed based on
ResourceMapping associated with the given
class.
Parameters:
clazz - The class to lookup the ResourceMapping
Parameters:
id - The id to unmarshall An array of all the ids |
| unmarshallIds | | Object[] unmarshallIds(ResourceMapping resourceMapping, Object id, MarshallingContext context)(Code) | | Unmarshalls the given id object into an array of all the id values. The results depends
on the type of the mappings (raw resource/class).
The unmarshalling is performed based on
ResourceMapping provided.
Parameters:
resourceMapping - The resource to perform the unmarshalling based on
Parameters:
id - The id to unmarshall An array of all the ids |
|
|