org.treetank.service.jaxrx.implementation

Class NodeIdRepresentation

java.lang.Object

org.treetank.service.jaxrx.implementation.NodeIdRepresentation

public class NodeIdRepresentation
extends Object

This class is responsible to work with database specific XML node id's. It allows to access a resource by a node id, modify an existing resource by node id, delete an existing resource by node id and to append a new resource to an existing XML element identified by a node id.

Author:

Patrick Lang, Lukas Lewandowski, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
NodeIdRepresentation(IStorage pDatabase) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSubResource(String resourceName, long nodeId, InputStream input, EIdAccessType type) This method is responsible to perform a POST request to a node id.
void	deleteResource(String resourceName, long nodeId) This method is responsible to delete an XML resource addressed through a unique node id (except root node id).
javax.ws.rs.core.StreamingOutput	getResource(String resourceName, long nodeId, Map<QueryParameter,String> queryParams) This method is responsible to deliver the whole XML resource addressed by a unique node id.
javax.ws.rs.core.StreamingOutput	getResourceByAT(String resourceName, long nodeId, Map<QueryParameter,String> queryParams, EIdAccessType accessType) This method is responsible to deliver the whole XML resource addressed by a unique node id.
void	modifyResource(String resourceName, long nodeId, InputStream newValue) This method is responsible to modify the XML resource, which is addressed through a unique node id.
javax.ws.rs.core.StreamingOutput	performQueryOnResource(String resourceName, long nodeId, String query, Map<QueryParameter,String> queryParams) This method is responsible to perform a XPath query expression on the XML resource which is addressed through a unique node id.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeIdRepresentation

public NodeIdRepresentation(IStorage pDatabase)

Constructor.

Parameters:

pDatabase - storage to be set

Method Detail

getResource

public javax.ws.rs.core.StreamingOutput getResource(String resourceName,
                                           long nodeId,
                                           Map<QueryParameter,String> queryParams)
                                             throws JaxRxException

This method is responsible to deliver the whole XML resource addressed by a unique node id.

Parameters:

resourceName - The name of the database, where the node id belongs.

nodeId - The unique node id of the requested resource.

queryParams - The optional query parameters.

Returns:

The whole XML resource addressed by a unique node id.

Throws:

JaxRxException - The exception occurred.

getResourceByAT

public javax.ws.rs.core.StreamingOutput getResourceByAT(String resourceName,
                                               long nodeId,
                                               Map<QueryParameter,String> queryParams,
                                               EIdAccessType accessType)
                                                 throws JaxRxException

This method is responsible to deliver the whole XML resource addressed by a unique node id.

Parameters:

resourceName - The name of the database, where the node id belongs.

nodeId - The unique node id of the requested resource.

queryParams - The optional query parameters.

accessType - The id access type to access a resource by a relative method type defined in EIdAccessType.

Returns:

The whole XML resource addressed by a unique node id.

Throws:

JaxRxException - The exception occurred.

performQueryOnResource

public javax.ws.rs.core.StreamingOutput performQueryOnResource(String resourceName,
                                                      long nodeId,
                                                      String query,
                                                      Map<QueryParameter,String> queryParams)

This method is responsible to perform a XPath query expression on the XML resource which is addressed through a unique node id.

Parameters:

resourceName - The name of the database, the node id belongs to.

nodeId - The node id of the requested resource.

query - The XPath expression.

queryParams - The optional query parameters (output, wrap, revision).

Returns:

The result of the XPath query expression.

deleteResource

public void deleteResource(String resourceName,
                  long nodeId)
                    throws JaxRxException

This method is responsible to delete an XML resource addressed through a unique node id (except root node id).

Parameters:

resourceName - The name of the database, which the node id belongs to.

nodeId - The unique node id.

Throws:

JaxRxException - The exception occurred.

modifyResource

public void modifyResource(String resourceName,
                  long nodeId,
                  InputStream newValue)
                    throws JaxRxException

This method is responsible to modify the XML resource, which is addressed through a unique node id.

Parameters:

resourceName - The name of the database, where the node id belongs to.

nodeId - The node id.

newValue - The new value of the node that has to be replaced.

Throws:

JaxRxException - The exception occurred.

addSubResource

public void addSubResource(String resourceName,
                  long nodeId,
                  InputStream input,
                  EIdAccessType type)
                    throws JaxRxException

This method is responsible to perform a POST request to a node id. This method adds a new XML subtree as first child or as right sibling to the node which is addressed through a node id.

Parameters:

resourceName - The name of the database, the node id belongs to.

nodeId - The node id.

input - The new XML subtree.

type - The type which indicates if the new subtree has to be inserted as right sibling or as first child.

Throws:

JaxRxException - The exception occurred.