org.gcube.common.searchservice.searchlibrary.resultset.elements

Class ResultSetRef

java.lang.Object

org.gcube.common.searchservice.searchlibrary.resultset.elements.ResultSetRef

public class ResultSetRef
extends Object

Placeholder for information on a ResultSet chain

Author:

UoA

Constructor Summary

Constructors

Constructor and Description
ResultSetRef() Creates a new ResultSetRef

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addResult(String result) Adds a new result in the results buffer
boolean	addText(String result) Adds a new result in the results buffer bypassing the validation
void	clear() Clears the underying structures
void	clearResults() Clears the underlying results buffer
int	getAccess() Get the access leasing
HeaderRef	getCurrentHeader() Retrieves info of the current header
String	getCurrentHeaderName() Retrieves the name of the current header
Date	getExpire_date() Get the time leasing
String	getHead() Retrives the head part
HeadMnemonic	getHmnemonic() Get security properties
String	getInWrap() Retrieves the file that shouldbe wrapped
Mnemonic	getMnemonic() Get security properties
Vector<String>	getResults() Retrieves the results heald in the underlying buffer
boolean	inWrap() Checks if there is a file o wrap
boolean	isDataFlow() Returns whether or not this RS offeres on demand production of results
boolean	isForward() Get the forward property
void	resetInWrap() Sets that there is no file to wrap
void	setAccess(int a) Sets whether or not this RS offeres erasure of parts
void	setCurrentHeader(HeaderRef header) Sets the header info that is current
void	setCurrentHeaderName(String header) Sets the current header file name
void	setDataFlow(boolean dataFlow) Sets whether or not this RS offeres on demand production of results
void	setExpire_date(Date expire_date) Set the time leasing
void	setForward(boolean forward) Set the forward property
void	setHead(String head) Sets the head file part of the chain
void	setHmnemonic(HeadMnemonic hmnemonic) Set security properties
void	setInWrap(String inwrap) Set that the payload to be persisted should be done wrapping the provided file
void	setMnemonic(Mnemonic mnemonic) Set security properties
void	setResults(Vector<String> results) Sets the underlying buffer to hold the provided records
void	updateHeaderNext(String next) Udates the next property of the current header
void	updateHeaderPrev(String prev) Udates the prev property of the current header

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultSetRef

public ResultSetRef()

Creates a new ResultSetRef

Method Detail

setHead

public void setHead(String head)

Sets the head file part of the chain

Parameters:

head - the head of the RS

setCurrentHeader

public void setCurrentHeader(HeaderRef header)

Sets the header info that is current

Parameters:

header - The current header

setCurrentHeaderName

public void setCurrentHeaderName(String header)

Sets the current header file name

Parameters:

header - The current header file name

getHead

public String getHead()

Retrives the head part

Returns:

Teh head part

getCurrentHeader

public HeaderRef getCurrentHeader()

Retrieves info of the current header

Returns:

The current header info

getCurrentHeaderName

public String getCurrentHeaderName()

Retrieves the name of the current header

Returns:

The current header name

addResult

public boolean addResult(String result)

Adds a new result in the results buffer

Parameters:

result - The record to add

Returns:

true if the result was valid and was added,false otherwise

addText

public boolean addText(String result)

Adds a new result in the results buffer bypassing the validation

Parameters:

result - The record to add

Returns:

true

getResults

public Vector<String> getResults()

Retrieves the results heald in the underlying buffer

Returns:

The available results

setResults

public void setResults(Vector<String> results)

Sets the underlying buffer to hold the provided records

Parameters:

results - The records to hold

updateHeaderNext

public void updateHeaderNext(String next)
                      throws Exception

Udates the next property of the current header

Parameters:

next - The value to be set

Throws:

Exception - An unrecoverable for the operation error occured

updateHeaderPrev

public void updateHeaderPrev(String prev)
                      throws Exception

Udates the prev property of the current header

Parameters:

prev - The value to be set

Throws:

Exception - An unrecoverable for the operation error occured

clearResults

public void clearResults()

Clears the underlying results buffer

clear

public void clear()

Clears the underying structures

setInWrap

public void setInWrap(String inwrap)

Set that the payload to be persisted should be done wrapping the provided file

Parameters:

inwrap - The file to wrap

getInWrap

public String getInWrap()

Retrieves the file that shouldbe wrapped

Returns:

Teh file to wrap

inWrap

public boolean inWrap()

Checks if there is a file o wrap

Returns:

true if a file should be wrapped, false otherwise

resetInWrap

public void resetInWrap()

Sets that there is no file to wrap

isDataFlow

public boolean isDataFlow()

Returns whether or not this RS offeres on demand production of results

Returns:

true if the RS offeres on demand production, false otherwise

setDataFlow

public void setDataFlow(boolean dataFlow)

Sets whether or not this RS offeres on demand production of results

Parameters:

dataFlow - true if the RS offeres on demand production, false otherwise

setAccess

public void setAccess(int a)

Sets whether or not this RS offeres erasure of parts

Parameters:

a - tha access leasing

getAccess

public int getAccess()

Get the access leasing

Returns:

access leasing

isForward

public boolean isForward()

Get the forward property

Returns:

true if forward property is enabled

setForward

public void setForward(boolean forward)

Set the forward property

Parameters:

forward - true if forward property is to be enabled

getExpire_date

public Date getExpire_date()

Get the time leasing

Returns:

time leasing

setExpire_date

public void setExpire_date(Date expire_date)

Set the time leasing

Parameters:

expire_date - for how long

getMnemonic

public Mnemonic getMnemonic()

Get security properties

Returns:

the security related class

setMnemonic

public void setMnemonic(Mnemonic mnemonic)

Set security properties

Parameters:

mnemonic - the security related class

getHmnemonic

public HeadMnemonic getHmnemonic()

Get security properties

Returns:

the security related class for the header

setHmnemonic

public void setHmnemonic(HeadMnemonic hmnemonic)

Set security properties

Parameters:

hmnemonic - the security related class