org.gcube.common.searchservice.searchlibrary.resultset

Class ResultSet

java.lang.Object

org.gcube.common.searchservice.searchlibrary.resultset.ResultSet

public class ResultSet
extends Object

The ResultSet element provides a container for placing produced records and for consuming them. It organizes them in a chain of parts explicitly created by the producer. It provides incremental population of the results through the chain of parts. The contents of the result set parts are immutable once created

Author:

UoA

Constructor Summary

Constructors

Constructor and Description
ResultSet(CreationParams params) Creates a new ResultSet
ResultSet(String filename) Creates a new ResultSet
ResultSet(String[] properties, boolean dataFlow) Creates a new ResultSet
ResultSet(String properties, boolean dataFlow) Creates a new ResultSet
ResultSet(String filename, int noDecrypt) Creates a new ResultSet
ResultSet(String filename, PrivateKey privkey) Creates a new ResultSet

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addResults(String[] results) Adds teh provided results to the underlying buffer
boolean	addText(String[] results) Adds teh provided text records in the underlying buffer
void	addWSEPR(String epr) Adds a WS-EPR serialization to the head properties container
void	clear() Clears underlying structures
String	cloneRS() Clones the implied ResultSet
void	disableAccessLeasing()
void	disableTimeLeasing()
void	endAuthoring() Stops the authoring of the current part and makes it available
String	executeQueryOnDocument(String xPath) Evaluates the provided xPath expression against the head part document and returns the output as a serialized string.
String	executeQueryOnHead(String xPath) Evaluates the provided xPath expression against the head part document and returns the output as a serialized string.
String[]	executeQueryOnResults(String xPath) Evaluates the provided expression against each of the results in the current payload part and if it produces output the entire result serialization is considered as output.
void	extendAccessLeasing(int extend) Extend the access leasing
boolean	extendTimeLeasing(Date extend) Extend the time leasing
String	filterRS(String xPath) Performs a filtering operation based on an provided xPath on the referenced ResultSet returning the name of the local file that holds the head part of the new ResultSet.
String	filterRS(String xPath, String[] properties) Performs a filtering operation based on an provided xPath on the referenced ResultSet returning the name of the local file that holds the head part of the new ResultSet.
int	getAccessLeasing() Get the access leasing
String	getCurrentContentPartName() Retrieves the name of the current payload part
String	getCurrentContentPartPayload() Retrieves the payload of the current content part
byte[]	getEncKey() Get the encryption key
String	getFileContent(String filename) Retrieves the content of the provided local file
boolean	getFirstPart() Sets the current part to be the first payload part
HeadMnemonic	getHeadMnemonic() Get security properties
String	getHeadName() Retrieves the name of the head part containing file
String	getHostIP() Retrieves the IP address of the host that the ResultSet receides in
String	getHostName() Retrieves the name of the host that the ResultSet receides in
Mnemonic	getMnemonic() Get security properties
boolean	getNextPart(int waitMax) Sets the next part in the chain as the current one waiting at most the provided amount of time in milliseconds for it to become available
int	getNumberOfResults(String type) Retrieves the number of results stored in a payload part of the ResultSet
boolean	getPreviousPart() Sets the current part to be the previous part
String[]	getProperties(String type) Retrieves the properties of the provided type
String	getResult(int index) Retrieves the result that has the specified index in the current payload part
String[]	getResults() Retrieves all the results that are in the current payload part
String[]	getResults(int from, int to) Retrieves all the results that are in the current payload part that have an index in the specified index span
ResultSetRef	getRSRef() Retrieves the container of the ResultSet info
Date	getTimeLeasing() Get the time leasing
boolean	isFirst() Checks if the current part is the first payload part
boolean	isForward() Is the RS forward reading only.
boolean	isLast() Checks if the current part is the last payload part
String	keepTop(int count, short type) Performs a keep top operation on the implied ResultSet chain and creates a bew ResultSet with the top kept.
String	keepTop(String[] properties, int count, short type) Performs a keep top operation on the implied ResultSet chain and creates a bew ResultSet with the top kept
RSConstants.CONTROLFLOW	more(long time) /** Checks whether or not more results should be produced.
boolean	nextAvailable() Checks without blocking if the next part in this chain is available
void	overrideProperties(PropertyElementBase[] properties) removes any existing properties and sets the new ones
void	overrideProperties(String properties) removes any existing properties and sets the new ones
boolean	removePreviousPart() Sets the current part to be the previous part
String	retrieveCustomProperties() Retrieves a serialization of the head custom properties
boolean	setForward(boolean f) Set an RS to be forward
String[]	splitClear() Splits the current payload part in sized defined by the RSConstants.partSize property
String[]	splitEncoded() Splits the current payload part in sized defined by the RSConstants.partSize property and encdes them using Base64 encoding
void	startNewPart() Starts a new part in the chain of parts, making the part that was currently authored available
String	transformByXSLT(String xslt) Performs an xslt transformation against the current payload part
String	transformByXSLTAndPersist(String xslt) Performs an xslt transformation against the current payload part
String	transformByXSLTAndPersist(Templates xslt) Performs an xslt transformation against the current payload part
String	transformRS(String transformation) Performs an xslt transfromation against the payload part of the implied ResultSet and creates a new ResultSet with payload the output of each transformation.
String	transformRS(String transformation, String[] properties) Performs an xslt transfromation against the payload part of the implied ResultSet and creates a new ResultSet with payload the output of each transformation.
void	wrapFile(String filename) Wraps the provided file content

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultSet

public ResultSet(CreationParams params)
          throws Exception

Creates a new ResultSet

Parameters:

params - RS creation params

Throws:

Exception - An unrecoverable for the operation error occured

ResultSet

public ResultSet(String[] properties,
         boolean dataFlow)
          throws Exception

Creates a new ResultSet

Parameters:

properties - The properties this ResultSet should have

dataFlow - wheteher or not this ResultSet should enable rcord production on demand

Throws:

Exception - An unrecoverable for the operation error occured

ResultSet

public ResultSet(String properties,
         boolean dataFlow)
          throws Exception

Creates a new ResultSet

Parameters:

properties - The properties this ResultSet should have

dataFlow - wheteher or not this ResultSet should enable rcord production on demand

Throws:

Exception - An unrecoverable for the operation error occured

ResultSet

public ResultSet(String filename)
          throws Exception

Creates a new ResultSet

Parameters:

filename - The file that holds the head of the existing ResultSet chain to point to

Throws:

Exception - An unrecoverable for the operation error occured

ResultSet

public ResultSet(String filename,
         int noDecrypt)
          throws Exception

Creates a new ResultSet

Parameters:

filename - The file that holds the head of the existing ResultSet chain to point to

noDecrypt - Flag saying to do a decrypt

Throws:

Exception - An unrecoverable for the operation error occured

ResultSet

public ResultSet(String filename,
         PrivateKey privkey)
          throws Exception

Creates a new ResultSet

Parameters:

filename - The file that holds the head of the existing ResultSet chain to point to

privkey - Private key to be used with the RS

Throws:

Exception - An unrecoverable for the operation error occurred

Method Detail

addWSEPR

public void addWSEPR(String epr)
              throws Exception

Adds a WS-EPR serialization to the head properties container

Parameters:

epr - The WS-EPR to add

Throws:

Exception - An unrecoverable for the operation error occured

getHeadName

public String getHeadName()
                   throws Exception

Retrieves the name of the head part containing file

Returns:

The name of the file

Throws:

Exception - An unrecoverable for the operation error occured

clear

public void clear()
           throws Exception

Clears underlying structures

Throws:

Exception - An unrecoverable for the operation error occured

getRSRef

public ResultSetRef getRSRef()

Retrieves the container of the ResultSet info

Returns:

The info container

addResults

public boolean addResults(String[] results)
                   throws Exception

Adds teh provided results to the underlying buffer

Parameters:

results - to add

Returns:

true if all the results were successfully added, false otherwise

Throws:

Exception - An unrecoverable for the operation error occured

addText

public boolean addText(String[] results)
                throws Exception

Adds teh provided text records in the underlying buffer

Parameters:

results - The records to add

Returns:

true if all the records were successfully written, false otherwise

Throws:

Exception - An unrecoverable for the operation error occured

more

public RSConstants.CONTROLFLOW more(long time)
                             throws Exception

/** Checks whether or not more results should be produced. THis operation blocks until an answer can be produced. This answer will define either that more results are nessecary, or the producer can relinguish any resources it has for producing more results because the ResultSet is no longer used, or the timeout the user specified has been reached

Parameters:

time - The timeout for the answer

Returns:

The answer

Throws:

Exception - An unrecoverabvle for the operation error has occured

startNewPart

public void startNewPart()
                  throws Exception

Starts a new part in the chain of parts, making the part that was currently authored available

Throws:

Exception - An unrecoverable for the operation error occured

endAuthoring

public void endAuthoring()
                  throws Exception

Stops the authoring of the current part and makes it available

Throws:

Exception - An unrecoverable for the operation error occured

overrideProperties

public void overrideProperties(PropertyElementBase[] properties)
                        throws Exception

removes any existing properties and sets the new ones

Parameters:

properties - teh proeprties to set

Throws:

Exception - An unrecoverable for the operatiuon error occured

overrideProperties

public void overrideProperties(String properties)
                        throws Exception

removes any existing properties and sets the new ones

Parameters:

properties - teh proeprties to set

Throws:

Exception - An unrecoverable for the operatiuon error occured

wrapFile

public void wrapFile(String filename)
              throws Exception

Wraps the provided file content

Parameters:

filename - Teh filename to wrap

Throws:

Exception - An unrecoverable for the operation error occured

getProperties

public String[] getProperties(String type)
                       throws Exception

Retrieves the properties of the provided type

Parameters:

type - The type of properties to retrieve

Returns:

The retrieved properties

Throws:

Exception - An unrecoverable for the operation error occured

nextAvailable

public boolean nextAvailable()
                      throws Exception

Checks without blocking if the next part in this chain is available

Returns:

true if it is, false otherwise

Throws:

Exception - An unrecoverable for the operation error occured

getNextPart

public boolean getNextPart(int waitMax)
                    throws Exception

Sets the next part in the chain as the current one waiting at most the provided amount of time in milliseconds for it to become available

Parameters:

waitMax - T he amount of time to wait for the next part to become available. If this is negative, a default amount of time defiened in RSConstants.sleepMax is used

Returns:

true if there is a next part and it has become the current one, false if there is no next part

Throws:

Exception - An unrecoverable for the operation error occured or the timer expired

getFirstPart

public boolean getFirstPart()
                     throws Exception

Sets the current part to be the first payload part

Returns:

true if the operation was successful,false otehrwise

Throws:

Exception - An unrecoverable for the operation error occured or the timer expired

getPreviousPart

public boolean getPreviousPart()
                        throws Exception

Sets the current part to be the previous part

Returns:

true if the operation was successful,false otehrwise

Throws:

Exception - An unrecoverable for the operation error occured or the timer expired

removePreviousPart

public boolean removePreviousPart()
                           throws Exception

Sets the current part to be the previous part

Returns:

true if the operation was successful,false otehrwise

Throws:

Exception - An unrecoverable for the operation error occured or the timer expired

isFirst

public boolean isFirst()
                throws Exception

Checks if the current part is the first payload part

Returns:

true if it is, false otherwise

Throws:

Exception - An unrecoverable for the operation error occured or the timer expired

isLast

public boolean isLast()
               throws Exception

Checks if the current part is the last payload part

Returns:

true if it is, false otherwise

Throws:

Exception - An unrecoverable for the operation error occured or the timer expired

getNumberOfResults

public int getNumberOfResults(String type)
                       throws Exception

Retrieves the number of results stored in a payload part of the ResultSet

Parameters:

type - The type of the RS part whose records should be conted

Returns:

The number of results

Throws:

Exception - An unrecoverable for the operation error occured

getCurrentContentPartPayload

public String getCurrentContentPartPayload()
                                    throws Exception

Retrieves the payload of the current content part

Returns:

The payload of the current payload part

Throws:

Exception - An unrecoverable for the operation error occured

getResult

public String getResult(int index)
                 throws Exception

Retrieves the result that has the specified index in the current payload part

Parameters:

index - The index of the result to be retrieved

Returns:

The result serialization

Throws:

Exception - An unrecoverable for the operation error occured

getResults

public String[] getResults()
                    throws Exception

Retrieves all the results that are in the current payload part

Returns:

An array of all the serialized results of the current payload part

Throws:

Exception - An unrecoverable for the operation error occured

getResults

public String[] getResults(int from,
                  int to)
                    throws Exception

Retrieves all the results that are in the current payload part that have an index in the specified index span

Parameters:

from - the starting index

to - the ending index

Returns:

An array of all the serialized results of the current payload part that have an index in the specified index span

Throws:

Exception - An unrecoverable for the operation error occured

getHostIP

public String getHostIP()
                 throws Exception

Retrieves the IP address of the host that the ResultSet receides in

Returns:

The IP address

Throws:

Exception - An unrecoverable for the operation error occured

getHostName

public String getHostName()
                   throws Exception

Retrieves the name of the host that the ResultSet receides in

Returns:

The host name

Throws:

Exception - An unrecoverable for the operation error occured

splitEncoded

public String[] splitEncoded()
                      throws Exception

Splits the current payload part in sized defined by the RSConstants.partSize property and encdes them using Base64 encoding

Returns:

An array with the parts names

Throws:

Exception - An unrecoverable for the operation error occured

splitClear

public String[] splitClear()
                    throws Exception

Splits the current payload part in sized defined by the RSConstants.partSize property

Returns:

An array with the parts names

Throws:

Exception - An unrecoverable for the operation error occured

getFileContent

public String getFileContent(String filename)
                      throws Exception

Retrieves the content of the provided local file

Parameters:

filename - The file whose content must e retrieved

Returns:

The file content

Throws:

Exception - An unrecoverable for the operation error occured

retrieveCustomProperties

public String retrieveCustomProperties()
                                throws Exception

Retrieves a serialization of the head custom properties

Returns:

The custom properties

Throws:

Exception - An unrecoverable for the operation error occured

cloneRS

public String cloneRS()
               throws Exception

Clones the implied ResultSet

Returns:

The name of the head file pointing to the new chain of parts

Throws:

Exception - An unrecoverable for the operation error occured

keepTop

public String keepTop(int count,
             short type)
               throws Exception

Performs a keep top operation on the implied ResultSet chain and creates a bew ResultSet with the top kept. The new ResultSet has the same properties with the current one

Parameters:

count - The number of top elements to keep

type - The type of operation to perform. This can be one of KeepTopThreadGeneric.PERPART, KeepTopThreadGeneric.PERRECORD

Returns:

The name of the head part of the new ResultSet

Throws:

Exception - An unrecoverable for the operation error occured

keepTop

public String keepTop(String[] properties,
             int count,
             short type)
               throws Exception

Performs a keep top operation on the implied ResultSet chain and creates a bew ResultSet with the top kept

Parameters:

properties - The properties the new ResultSet must have

count - The number of top elements to keep

type - The type of operation to perform. This can be one of KeepTopThreadGeneric.PERPART, KeepTopThreadGeneric.PERRECORD

Returns:

The name of the head part of the new ResultSet

Throws:

Exception - An unrecoverable for the operation error occured

getCurrentContentPartName

public String getCurrentContentPartName()
                                 throws Exception

Retrieves the name of the current payload part

Returns:

The file name

Throws:

Exception - An unrecoverable for the operation error occured

executeQueryOnHead

public String executeQueryOnHead(String xPath)
                          throws Exception

Evaluates the provided xPath expression against the head part document and returns the output as a serialized string.

Parameters:

xPath - The xPath to be evaluated

Returns:

The serialization of the evaluation output

Throws:

Exception - An unrecoverable for the operation error occured

executeQueryOnDocument

public String executeQueryOnDocument(String xPath)
                              throws Exception

Evaluates the provided xPath expression against the head part document and returns the output as a serialized string.

Parameters:

xPath - The xPath to be evaluated

Returns:

The serialization of the evaluation output

Throws:

Exception - An unrecoverable for the operation error occured

executeQueryOnResults

public String[] executeQueryOnResults(String xPath)
                               throws Exception

Evaluates the provided expression against each of the results in the current payload part and if it produces output the entire result serialization is considered as output.

Parameters:

xPath - The xPath expression to be evaluated. it must start evaluation under the current node

Returns:

The results that produced output for the provided expression

Throws:

Exception - An unrecoverable for the operation error occured

filterRS

public String filterRS(String xPath)
                throws Exception

Performs a filtering operation based on an provided xPath on the referenced ResultSet returning the name of the local file that holds the head part of the new ResultSet. The xPath is applied to each result and should begin referencing the current node

Parameters:

xPath - The xpath to apply to the referenced ResultSet results to create the new one

Returns:

The name of the file that holds the head part of the created ResultSet

Throws:

Exception - An unrecoverable for the operation error occured

filterRS

public String filterRS(String xPath,
              String[] properties)
                throws Exception

Performs a filtering operation based on an provided xPath on the referenced ResultSet returning the name of the local file that holds the head part of the new ResultSet. The xPath is applied to each result and should begin referencing the current node

Parameters:

xPath - The xpath to apply to the referenced ResultSet results to create the new one

properties - The properties the new ResultSet should have

Returns:

The name of the file that holds the head part of the created ResultSet

Throws:

Exception - An unrecoverable for the operation error occured

transformByXSLT

public String transformByXSLT(String xslt)
                       throws Exception

Performs an xslt transformation against the current payload part

Parameters:

xslt - The xslt to apply

Returns:

The output of the transformation

Throws:

Exception - An unrecoverable for the operation error occured

transformByXSLTAndPersist

public String transformByXSLTAndPersist(String xslt)
                                 throws Exception

Performs an xslt transformation against the current payload part

Parameters:

xslt - The xslt to apply

Returns:

The name of the file that holds the output

Throws:

Exception - An unrecoverable for the operation error occured

transformByXSLTAndPersist

public String transformByXSLTAndPersist(Templates xslt)
                                 throws Exception

Performs an xslt transformation against the current payload part

Parameters:

xslt - The xslt to apply

Returns:

The name of the file that holds the output

Throws:

Exception - An unrecoverable for the operation error occured

transformRS

public String transformRS(String transformation)
                   throws Exception

Performs an xslt transfromation against the payload part of the implied ResultSet and creates a new ResultSet with payload the output of each transformation. The new ResultSet has as properties the properties of the current one

Parameters:

transformation - The tranformation to apply

Returns:

The name of the file holding the new ResultSet head part

Throws:

Exception - An unrecoverable for the operation error occured

transformRS

public String transformRS(String transformation,
                 String[] properties)
                   throws Exception

Performs an xslt transfromation against the payload part of the implied ResultSet and creates a new ResultSet with payload the output of each transformation. The new ResultSet has as properties the properties of the current one

Parameters:

transformation - The tranformation to apply

properties - The properties the new ResultSet must have

Returns:

The name of the file holding the new ResultSet head part

Throws:

Exception - An unrecoverable for the operation error occured

disableAccessLeasing

public void disableAccessLeasing()
                          throws Exception

Throws:

Exception - when access leasing cannot be disabled

extendAccessLeasing

public void extendAccessLeasing(int extend)
                         throws Exception

Extend the access leasing

Parameters:

extend - Extend for how much

Throws:

Exception - when extending failed

getAccessLeasing

public int getAccessLeasing()
                     throws Exception

Get the access leasing

Returns:

the access leasing

Throws:

Exception - when retriving the access leasing failed

isForward

public boolean isForward()
                  throws Exception

Is the RS forward reading only.

Returns:

true if rs is of forward reading type

Throws:

Exception - when information retrival failed

setForward

public boolean setForward(boolean f)
                   throws Exception

Set an RS to be forward

Parameters:

f - true if to set forward

Returns:

true on success

Throws:

Exception - when seting forward failed

getTimeLeasing

public Date getTimeLeasing()
                    throws Exception

Get the time leasing

Returns:

the time leasing

Throws:

Exception - when retriving the time leasing failed

extendTimeLeasing

public boolean extendTimeLeasing(Date extend)
                          throws Exception

Extend the time leasing

Parameters:

extend - Extend for how long

Returns:

true if successfull

Throws:

Exception - when extending failed

disableTimeLeasing

public void disableTimeLeasing()
                        throws Exception

Throws:

Exception - when time leasing cannot be disabled

getMnemonic

public Mnemonic getMnemonic()

Get security properties

Returns:

the security related class

getHeadMnemonic

public HeadMnemonic getHeadMnemonic()

Get security properties

Returns:

the security related class for the header

getEncKey

public byte[] getEncKey()
                 throws Exception

Get the encryption key

Returns:

the key

Throws:

Exception - An error occurred