com.stormpath.sdk.impl.query

Class Expansion

java.lang.Object

com.stormpath.sdk.impl.query.Expansion

All Implemented Interfaces:

Criterion, Serializable

Direct Known Subclasses:

CollectionExpansion

public class Expansion
extends Object
implements Criterion

An expansion represents a request to materialize a referenced resource within the requested resource itself.

For example, an Account resource references its parent/owning directory, itself a complex object. Normally when returning an Account resource, the account's directory is represented as a linked resource, and the directory's properties are not included in the Account's resource representation.

If, when querying for the account, an expansion directive is specified (e.g. expand=directory), then the caller is requesting that not only should the account be returned materialized but also that its referenced directory should be included in the result, materialized as well. For example:

Default Behavior (no expansion)

Request: GET /accounts/someAccountId
Response:

 {
     "href": "some/account/uri",
     "name": "foo",
     ...
     "directory": {
         "href": "the/directory/uri"
     }
 }
 

Notice that the directory property is a complex object with only an href property - i.e. it is a link only.

With Expansion

Request: GET /accounts/someAccountId?expand=directory
Response:

 {
     "href": "some/account/uri",
     "name": "foo",
     ...
     "directory": {
         "href": "the/directory/uri"
         "name": "A directory"
         "description": "A description",
         ...
     }
 }
 

Notice the expansion directive caused the second result to materialize and include the referenced directory (and its properties) in addition to the other account properties.

Since:

0.8

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Expansion(String name)

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Expansion

public Expansion(String name)

Method Detail

getName

public String getName()

toString

public String toString()

Specified by:

toString in interface Criterion

Overrides:

toString in class Object