|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MarshallingStrategy
Responsible for marhslling and unmarashlling high level objects (a.k.a root object)
to and from Resource
.
Method Summary | |
---|---|
Resource |
marshall(Object root)
Marshalls the given Object into a Resource based on the ResourceMapping
associated with the provided object. |
Resource |
marshall(String alias,
Object root)
Marshalls the given Object into a Resource based on the ResourceMapping
associated with the provided alias. |
Resource |
marshallIds(Class clazz,
Object id)
Marshalls the give id object into a Resource (a resource having only its ids set). |
Resource |
marshallIds(Object id)
Marshalls the given id object into a Resource (a resource having only its ids set). |
void |
marshallIds(Object root,
Object id)
Marhsalls the give id into the actual object. |
Resource |
marshallIds(ResourceMapping resourceMapping,
Object id)
Marshalls the give id object into a Resource (a resource having only its ids set). |
void |
marshallIds(ResourceMapping resourceMapping,
Object root,
Object id)
Marhsalls the give id into the actual object. |
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). |
Resource |
marshallIds(String alias,
Object id)
Marshalls the give id object into a Resource (a resource having only its ids set). |
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(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. |
Object[] |
unmarshallIds(String alias,
Object id)
Unmarshalls the given id object into an array of all the id values. |
Method Detail |
---|
Object unmarshall(Resource resource)
ResourceMapping
regsitered under the Resource
alias.
resource
- The resource to unmarshall from
Object unmarshall(Resource resource, MarshallingContext context)
ResourceMapping
regsitered under the Resource
alias WITHIN the given marshalling context.
resource
- The resource to unmarshall fromcontext
- The context to unmarshall the resource within
Resource marshall(String alias, Object root)
Resource
based on the ResourceMapping
associated with the provided alias. Returns null
if there are no mappings.
alias
- The alias to look up the ResourceMapping
root
- The object to marshall into the resource
null
if has no mappingResource marshall(Object root)
Resource
based on the ResourceMapping
associated with the provided object. If the object implements AliasedObject
,
the alias will be used to look up the ResourceMapping
, otherwise, the object class will be used.
root
- The object to marshall into a resource
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. 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
id
- The id to marshall into a Resource
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. 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
alias
- The alias to look up the ResourceMapping
basedid
- The id to marshall into a Resource
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. 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
clazz
- The class to look up the ResourceMapping
basedid
- The id to marshall into a Resource
Resource marshallIds(ResourceMapping resourceMapping, Object id)
resourceMapping
- The resource mapping holding how to marhsall the idsid
- The id to marshall into a Resource
boolean marshallIds(Resource resource, ResourceMapping resourceMapping, Object id, MarshallingContext context)
resource
- The resource to marhsll the ids intoresourceMapping
- The resource mapping holding how to marhsall the idsid
- The id to marshall into a Resource
true
if stored properties were added to the Resource
.void marshallIds(Object root, Object id)
root
- The object to marshall the ids intoid
- The id to marshall into the root objectvoid marshallIds(ResourceMapping resourceMapping, Object root, Object id)
resourceMapping
- The resource mapping for the given objectroot
- The object to marshall the ids intoid
- The id to marshall into the root objectObject[] unmarshallIds(String alias, Object id)
ResourceMapping
associated with the given
alias.
alias
- The alias to lookup the ResourceMapping
id
- The id to unmarshall
Object[] unmarshallIds(Class clazz, Object id)
ResourceMapping
associated with the given
class.
clazz
- The class to lookup the ResourceMapping
id
- The id to unmarshall
Object[] unmarshallIds(ResourceMapping resourceMapping, Object id, MarshallingContext context)
ResourceMapping
provided.
resourceMapping
- The resource to perform the unmarshalling based onid
- The id to unmarshall
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |