eu.dnetlib.enabling.resultset

Interface ResultSet

All Superinterfaces:

Observable

All Known Subinterfaces:

PushResultSet

All Known Implementing Classes:

AbstractObservableResultset, LocalResultSetImpl, TransientPushResultSetImpl

public interface ResultSet
extends Observable

A ResultSet represents a set of data results.

Author:

marko

Method Summary

Modifier and Type	Method and Description
void	close() close a resultset.
void	destroy() Destroy the resultset and free associated resources, remove it from the ResultSetRegistry.
String	getIdentifier() get the resource identifier.
int	getNumberOfResults() get the number of result elements present in the resultset.
List<String>	getResults(int fromPosition, int toPosition) get a 'page' of results.
boolean	isDestroyed() Tells if the resultset is destroyed.
boolean	isOpen() Tells if the resultset is open or closed.
void	setIdentifier(String rsId) sets the resource identifier.

Methods inherited from interface eu.dnetlib.enabling.resultset.observer.Observable

addObserver

Method Detail

getIdentifier

String getIdentifier()

get the resource identifier.

Returns:

rsId

setIdentifier

void setIdentifier(String rsId)

sets the resource identifier. The ResultSetRegistry will assign a new rsId.

Parameters:

rsId - allocated resultset identifier

getResults

List<String> getResults(int fromPosition,
                        int toPosition)

get a 'page' of results.

Parameters:

fromPosition - from 1

toPosition - last included

Returns:

a page of data

getNumberOfResults

int getNumberOfResults()

get the number of result elements present in the resultset.

Returns:

number of results

isOpen

boolean isOpen()

Tells if the resultset is open or closed.

Returns:

true if open

close

void close()

close a resultset.

isDestroyed

boolean isDestroyed()

Tells if the resultset is destroyed.

Returns:

true if the resultset is destroyed.

destroy

void destroy()

Destroy the resultset and free associated resources, remove it from the ResultSetRegistry. After calling this method, the resultset is no more accessible from other services.