Package de.uni_trier.wi2.procake.retrieval.impl

Class RetrievalResultListImpl

java.lang.Object

de.uni_trier.wi2.procake.retrieval.impl.RetrievalResultListImpl

All Implemented Interfaces:

RetrievalResultList, Iterable<RetrievalResult>

Direct Known Subclasses:

DependencyRetrievalResultListImpl

public class RetrievalResultListImpl
extends Object
implements RetrievalResultList

This class acts as a wrapper for a set of RetrievalResults. An object of this class is created in the retrieval process.

Author:

rmaximi

Constructor Summary

Constructors

Constructor	Description
RetrievalResultListImpl()

Method Summary

Modifier and Type	Method	Description
void	add(RetrievalResult rri)	Adds a retrieval result to the list.
RetrievalResultListImpl	fromXML(String retrievalResultListXML)	Converts a serialized RetrievalResultList-XML into a Query-object
RetrievalResult	getLast()
Query	getQuery()
long	getRetrievalTime()
long	getRetrievalTime(String format)
String	getRetrievalTimeString()
String	getRetrievalTimeString(String format)
Iterator<RetrievalResult>	iterator()
void	remove(RetrievalResult object)	Removes a retrieval result from the list.
void	removeLast()
void	setQuery(Query query)
void	setRetrievalTime(long retrievalTimeNano)	Set the retrieval time.
int	size()
Stream<RetrievalResult>	stream()	Returns a stream of the retrieval results.
ReadableObjectPool<DataObject>	toObjectPool()	Transforms this retrieval result list into a WriteableObjectPool.
String	toString()
String	toXML()	Converts full RetrievalResultList to XML
String	toXML(HashMap<Class,List<String>> toOmit)	Converts RetrievalResultList to XML, ignoring the fields specified in toOmit

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RetrievalResultListImpl

public RetrievalResultListImpl()

Method Detail

add

public void add(RetrievalResult rri)

Description copied from interface: RetrievalResultList

Adds a retrieval result to the list.

Specified by:

add in interface RetrievalResultList

Parameters:

rri - The retrieval result to add.

getLast

public RetrievalResult getLast()

iterator

public Iterator<RetrievalResult> iterator()

Specified by:

iterator in interface Iterable<RetrievalResult>

Specified by:

iterator in interface RetrievalResultList

Returns:

an ordered iterator over all retrieval results starting with the most similar one

remove

public void remove(RetrievalResult object)

Description copied from interface: RetrievalResultList

Removes a retrieval result from the list.

Specified by:

remove in interface RetrievalResultList

Parameters:

object - The retrieval result to remove.

removeLast

public void removeLast()

size

public int size()

Specified by:

size in interface RetrievalResultList

Returns:

The number of retrieval results.

toString

public String toString()

Overrides:

toString in class Object

toObjectPool

public ReadableObjectPool<DataObject> toObjectPool()

Description copied from interface: RetrievalResultList

Transforms this retrieval result list into a WriteableObjectPool.

Specified by:

toObjectPool in interface RetrievalResultList

Returns:

the transformed pool

getRetrievalTime

public long getRetrievalTime()

Specified by:

getRetrievalTime in interface RetrievalResultList

Returns:

The time used for retrieval in nanoseconds.

setRetrievalTime

public void setRetrievalTime(long retrievalTimeNano)

Description copied from interface: RetrievalResultList

Set the retrieval time.

Specified by:

setRetrievalTime in interface RetrievalResultList

Parameters:

retrievalTimeNano - the retrieval time in nanoseconds

getRetrievalTime

public long getRetrievalTime(String format)

Specified by:

getRetrievalTime in interface RetrievalResultList

Parameters:

format - The format for the time (nanoseconds, microseconds, milliseconds, seconds)

Returns:

The time used for retrieval in the specified format.

getRetrievalTimeString

public String getRetrievalTimeString()

Specified by:

getRetrievalTimeString in interface RetrievalResultList

Returns:

The time used for retrieval as formatted String

getRetrievalTimeString

public String getRetrievalTimeString(String format)

Specified by:

getRetrievalTimeString in interface RetrievalResultList

Parameters:

format - The format for the time (nanoseconds, microseconds, milliseconds, seconds)

Returns:

The time used for retrieval as String in the specified format.

getQuery

public Query getQuery()

setQuery

public void setQuery(Query query)

stream

public Stream<RetrievalResult> stream()

Description copied from interface: RetrievalResultList

Returns a stream of the retrieval results.

Specified by:

stream in interface RetrievalResultList

Returns:

a stream of results

toXML

public String toXML()

Description copied from interface: RetrievalResultList

Converts full RetrievalResultList to XML

Specified by:

toXML in interface RetrievalResultList

Returns:

XML String

toXML

public String toXML(HashMap<Class,List<String>> toOmit)

Description copied from interface: RetrievalResultList

Converts RetrievalResultList to XML, ignoring the fields specified in toOmit

Specified by:

toXML in interface RetrievalResultList

Parameters:

toOmit - HashMap that contains classes as a key and a corresponding list of fields that should be ignored in the particular class

Returns:

XML String

fromXML

public RetrievalResultListImpl fromXML(String retrievalResultListXML)

Description copied from interface: RetrievalResultList

Converts a serialized RetrievalResultList-XML into a Query-object

Specified by:

fromXML in interface RetrievalResultList

Parameters:

retrievalResultListXML - Query XML String

Returns:

Query-object