io.katharsis.request.path

Class FieldPath

java.lang.Object

io.katharsis.request.path.JsonPath

io.katharsis.request.path.FieldPath

Direct Known Subclasses:

RelationshipsPath

public class FieldPath
extends JsonPath

Represents a part of a path which relate a field of a resource e.g. for /resource/1/field the first element will be an object of ResourcePath type and the second will be of FieldPath type. FieldPath can refer only to relationship fields.

Field Summary

Fields inherited from class io.katharsis.request.path.JsonPath

childResource, elementName, ids, parentResource

Constructor Summary

Constructors

Constructor and Description
FieldPath(String elementName)

Method Summary

Modifier and Type	Method and Description
PathIds	getIds()
String	getResourceName() Returns name of a resource the last resource in requested path.
boolean	isCollection() Returns true if a JsonPath concerns a collection.
void	setIds(PathIds ids)

Methods inherited from class io.katharsis.request.path.JsonPath

equals, getChildResource, getElementName, getParentResource, hashCode, setChildResource, setParentResource

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldPath

public FieldPath(String elementName)

Method Detail

isCollection

public boolean isCollection()

Description copied from class: JsonPath

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

Specified by:

isCollection in class JsonPath

Returns:

true if a path concern a collection

getResourceName

public String getResourceName()

Description copied from class: JsonPath

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.

Specified by:

getResourceName in class JsonPath

Returns:

nam of the lase resource

getIds

public PathIds getIds()

Overrides:

getIds in class JsonPath

setIds

public void setIds(PathIds ids)

Overrides:

setIds in class JsonPath