io.katharsis.request.path

Class JsonPath

java.lang.Object

io.katharsis.request.path.JsonPath

Direct Known Subclasses:

FieldPath, ResourcePath

public abstract class JsonPath
extends Object

Represent a JSON API path sent to the server. Each resource or field defined in the path is represented by one derived class of JsonPath object. It is represented in a form of a doubly-linked list which must start with one or more ResourcePath instances and can end with either FieldPath or LinksPath instance.

Field Summary

Fields

Modifier and Type	Field and Description
protected JsonPath	childResource Entry closer to path's end
protected String	elementName Name of a resource or a filed
protected PathIds	ids Unique identifier of a field
protected JsonPath	parentResource Entry closer to path's beginning

Constructor Summary

Constructors

Constructor and Description
JsonPath(String elementName)
JsonPath(String elementName, PathIds pathIds)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
JsonPath	getChildResource()
String	getElementName() Returns name of the current element.
PathIds	getIds()
JsonPath	getParentResource()
abstract String	getResourceName() Returns name of a resource the last resource in requested path.
int	hashCode()
abstract boolean	isCollection() Returns true if a JsonPath concerns a collection.
void	setChildResource(JsonPath childResource)
void	setIds(PathIds ids)
void	setParentResource(JsonPath parentResource)

Methods inherited from class java.lang.Object

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

Field Detail

elementName

protected String elementName

Name of a resource or a filed

ids

protected PathIds ids

Unique identifier of a field

parentResource

protected JsonPath parentResource

Entry closer to path's beginning

childResource

protected JsonPath childResource

Entry closer to path's end

Constructor Detail

JsonPath

public JsonPath(String elementName)

JsonPath

public JsonPath(String elementName,
                PathIds pathIds)

Method Detail

isCollection

public abstract boolean isCollection()

Returns true if a JsonPath concerns a collection. It can happen if there's no or more than one id provided.

Returns:

true if a path concern a collection

getResourceName

public abstract String getResourceName()

Returns name of a resource the last resource in requested path. There can be paths that concern relations. In this case a elementName from parent JsonPath should be retrieved.

Returns:

nam of the lase resource

getElementName

public String getElementName()

Returns name of the current element. It can be either resource type or resource's field.

Returns:

name of the element

getIds

public PathIds getIds()

setIds

public void setIds(PathIds ids)

getParentResource

public JsonPath getParentResource()

setParentResource

public void setParentResource(JsonPath parentResource)

getChildResource

public JsonPath getChildResource()

setChildResource

public void setChildResource(JsonPath childResource)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object