com.epimorphics.server.webapi.dsapi

Class State

java.lang.Object

com.epimorphics.server.webapi.dsapi.State

public class State
extends Object

Represents a Dataset display state from a request. May be used to define a projection or to refine the context for component range computation. Can be set from query/post parameters or a json payload. Only single valued query parameters are allowed for compatibility with JSON format.

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
static String	FACET_COUNTS_PARAM
static String	LANG_FILTER_PARAM
static String	LIMIT_PARAM
static String	OFFSET_PARAM
static String	SORT_PARAM
protected Map<String,Object>	state
static String	TEXT_SEARCH_PARAM

Constructor Summary

Constructors

Constructor and Description
State()
State(org.apache.jena.atlas.json.JsonObject jstate)
State(javax.ws.rs.core.MultivaluedMap<String,String> params)

Method Summary

Methods

Modifier and Type	Method and Description
int	getInt(String key, int deflt) Return a state component as a integer, if possible, otherwise return the default.
Range	getRangeFor(DSAPIComponent c) Return the filter range for this description, or null if there is no restriction
String	getString(String key) Return a state component as a string
boolean	hasKey(String key)
Set<String>	keySet()

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_SEARCH_PARAM

public static final String TEXT_SEARCH_PARAM

See Also:

Constant Field Values

SORT_PARAM

public static final String SORT_PARAM

See Also:

Constant Field Values

OFFSET_PARAM

public static final String OFFSET_PARAM

See Also:

Constant Field Values

LIMIT_PARAM

public static final String LIMIT_PARAM

See Also:

Constant Field Values

LANG_FILTER_PARAM

public static final String LANG_FILTER_PARAM

See Also:

Constant Field Values

FACET_COUNTS_PARAM

public static final String FACET_COUNTS_PARAM

See Also:

Constant Field Values

state

protected Map<String,Object> state

Constructor Detail

State

public State()

State

public State(javax.ws.rs.core.MultivaluedMap<String,String> params)

State

public State(org.apache.jena.atlas.json.JsonObject jstate)

Method Detail

hasKey

public boolean hasKey(String key)

keySet

public Set<String> keySet()

getRangeFor

public Range getRangeFor(DSAPIComponent c)

Return the filter range for this description, or null if there is no restriction

getString

public String getString(String key)

Return a state component as a string

getInt

public int getInt(String key,
         int deflt)

Return a state component as a integer, if possible, otherwise return the default.