org.structr.rest.resource

Class TypeResource

java.lang.Object

org.structr.rest.resource.Resource

org.structr.rest.resource.WrappingResource

org.structr.rest.resource.FilterableResource

org.structr.rest.resource.SortableResource

org.structr.rest.resource.TypeResource

public class TypeResource
extends SortableResource

Represents a bulk type match. A TypeResource will always result in a list of elements when it is the last element in an URI. A TypeResource that is not the first element in an URI will try to find a pre-defined relationship between preceding and the node type (defined by AbstractNode#getRelationshipWith) and follow that path.

Author:

Christian Morgner

Field Summary

Fields

Modifier and Type	Field and Description
protected Class	entityClass
protected boolean	isNode
protected Query	query
protected String	rawType
protected javax.servlet.http.HttpServletRequest	request
protected Class<? extends SearchCommand>	searchCommandType

Fields inherited from class org.structr.rest.resource.WrappingResource

wrappedResource

Fields inherited from class org.structr.rest.resource.Resource

idProperty, securityContext

Constructor Summary

Constructors

Constructor and Description
TypeResource()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkAndConfigure(String part, SecurityContext securityContext, javax.servlet.http.HttpServletRequest request) Check and configure this instance with the given values.
void	collectSearchAttributes(Query query)
NodeInterface	createNode(Map<String,Object> propertySet)
Result	doGet(PropertyKey sortKey, boolean sortDescending, int pageSize, int page, String offsetId)
RestMethodResult	doPost(Map<String,Object> propertySet)
RestMethodResult	doPut(Map<String,Object> propertySet)
Class	getEntityClass()
String	getRawType()
String	getResourceSignature()
String	getUriPart()
boolean	isCollectionResource()
void	setEntityClass(Class<? extends GraphObject> type)
void	setSearchCommandType(Class<? extends SearchCommand> searchCommand)
Resource	tryCombineWith(Resource next)

Methods inherited from class org.structr.rest.resource.WrappingResource

isPrimitiveArray, wrapResource

Methods inherited from class org.structr.rest.resource.Resource

applyDefaultSorting, buildLocationHeader, configureIdProperty, configurePropertyView, createPostTransaction, doDelete, doHead, doOptions, extractDistanceSearch, extractSearchableAttributes, findPropertyKey, parseInteger, postProcessResultSet, setSecurityContext

Methods inherited from class java.lang.Object

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

Field Detail

searchCommandType

protected Class<? extends SearchCommand> searchCommandType

entityClass

protected Class entityClass

rawType

protected String rawType

request

protected javax.servlet.http.HttpServletRequest request

query

protected Query query

isNode

protected boolean isNode

Constructor Detail

TypeResource

public TypeResource()

Method Detail

checkAndConfigure

public boolean checkAndConfigure(String part,
                        SecurityContext securityContext,
                        javax.servlet.http.HttpServletRequest request)
                          throws FrameworkException

Description copied from class: Resource

Check and configure this instance with the given values. Please note that you need to set the security context of your class in this method.

Specified by:

checkAndConfigure in class Resource

Parameters:

part - the uri part that matched this resource

securityContext - the security context of the current request

request - the current request

Returns:

whether this resource accepts the given uri part

Throws:

FrameworkException

doGet

public Result doGet(PropertyKey sortKey,
           boolean sortDescending,
           int pageSize,
           int page,
           String offsetId)
             throws FrameworkException

Specified by:

doGet in class Resource

Throws:

FrameworkException

doPost

public RestMethodResult doPost(Map<String,Object> propertySet)
                        throws FrameworkException

Overrides:

doPost in class WrappingResource

Throws:

FrameworkException

doPut

public RestMethodResult doPut(Map<String,Object> propertySet)
                       throws FrameworkException

Overrides:

doPut in class Resource

Throws:

FrameworkException

createNode

public NodeInterface createNode(Map<String,Object> propertySet)
                         throws FrameworkException

Throws:

FrameworkException

tryCombineWith

public Resource tryCombineWith(Resource next)
                        throws FrameworkException

Overrides:

tryCombineWith in class SortableResource

Throws:

FrameworkException

getUriPart

public String getUriPart()

Overrides:

getUriPart in class WrappingResource

getRawType

public String getRawType()

getEntityClass

public Class getEntityClass()

Overrides:

getEntityClass in class WrappingResource

setEntityClass

public void setEntityClass(Class<? extends GraphObject> type)

setSearchCommandType

public void setSearchCommandType(Class<? extends SearchCommand> searchCommand)

getResourceSignature

public String getResourceSignature()

Specified by:

getResourceSignature in class Resource

isCollectionResource

public boolean isCollectionResource()

Overrides:

isCollectionResource in class WrappingResource

collectSearchAttributes

public void collectSearchAttributes(Query query)
                             throws FrameworkException

Throws:

FrameworkException