org.vamdc.tapservice.api
Interface RequestInterface


public interface RequestInterface

Interface that VAMDC-TAP node software implements to communicate with database plugin

Author:
doronin

Method Summary
 boolean checkBranch(org.vamdc.dictionary.Requestable branch)
          Check if we are requested to build certain part of XSAMS
 org.apache.cayenne.ObjectContext getCayenneContext()
          Get Apache Cayenne object context, if you want to talk to database using Apache Cayenne
 org.slf4j.Logger getLogger(Class<?> classname)
          Get logger
 org.vamdc.tapservice.vss2.Query getQuery()
          Get query object itself
 String getQueryString()
          Get query string, useful for logging purposes
 Collection<org.vamdc.tapservice.vss2.RestrictExpression> getRestricts()
          Get list of RestrictExpression from query, if one wants to process query in dummy AND'ed list mode
 org.vamdc.tapservice.vss2.LogicNode getRestrictsTree()
          Get normalized logic tree from query, used if one wants to process query in smart way.
 org.vamdc.xsams.XSAMSManager getXsamsManager()
          Get XSAMSData wrapper.
 boolean isValid()
          Returns true if request is valid and should be processed
 void setLastModified(Date date)
          Set the date corresponding to the last-modified date response header
 

Method Detail

getXsamsManager

org.vamdc.xsams.XSAMSManager getXsamsManager()
Get XSAMSData wrapper. It contains several helper methods, and all created XSAMS branches should be attached to it.

Returns:
XSAMSData wrapper

getCayenneContext

org.apache.cayenne.ObjectContext getCayenneContext()
Get Apache Cayenne object context, if you want to talk to database using Apache Cayenne

Returns:
Apache Cayenne object context

getRestricts

Collection<org.vamdc.tapservice.vss2.RestrictExpression> getRestricts()
Get list of RestrictExpression from query, if one wants to process query in dummy AND'ed list mode

Returns:
list of RestrictExpression from query

getRestrictsTree

org.vamdc.tapservice.vss2.LogicNode getRestrictsTree()
Get normalized logic tree from query, used if one wants to process query in smart way.
In the tree only nodes passed through

Returns:
root element of restricts tree
See Also:
are left, others are omitted (as if they are always resulting in TRUE expression).

isValid

boolean isValid()
Returns true if request is valid and should be processed

Returns:
request validity

getQuery

org.vamdc.tapservice.vss2.Query getQuery()
Get query object itself


getLogger

org.slf4j.Logger getLogger(Class<?> classname)
Get logger

Returns:
slf4j logger

getQueryString

String getQueryString()
Get query string, useful for logging purposes

Returns:
input query string

checkBranch

boolean checkBranch(org.vamdc.dictionary.Requestable branch)
Check if we are requested to build certain part of XSAMS

Parameters:
branch - element from @see org.vamdc.dictionary.Requestable
Returns:
true if that part is requested

setLastModified

void setLastModified(Date date)
Set the date corresponding to the last-modified date response header

Parameters:
date - java.util.Date reflecting the newest response record date


Copyright © 2012 VAMDC. All Rights Reserved.