gr.uoa.di.madgik.searchlibrary.operatorlibrary.indexfuse
Class ScanElement

java.lang.Object
  gr.uoa.di.madgik.searchlibrary.operatorlibrary.indexfuse.ScanElement

public class ScanElement
extends Object

Placeholder for input org.gcube.searchservice.searchlibrary.resultset.ResultSet file buffer and join related structs

Author:

UoA

Constructor Summary

ScanElement(gr.uoa.di.madgik.grs.reader.ForwardReader<gr.uoa.di.madgik.grs.record.Record> reader, Queue<JoinElement> queue, Object synchThis, short inputID, short metaInputID, long timeout, TimeUnit timeUnit)
Create a new ScanElement

Method Summary

long	getCounter() Retrieves the counter for this ScanElement
DiskBuffer	getFileBuf() Retrieves the file buffer
short	getInputID() Retrieves the input id of this ScanElement
short	getMetaInputID() Retrieves the metadata input id of this ScanElement
Queue<JoinElement>	getQueue() Retrieves the queue used to place records
gr.uoa.di.madgik.grs.reader.ForwardReader<gr.uoa.di.madgik.grs.record.Record>	getReader() Retrieves the RSXMLIterator
Object	getSynchThis() Retrieves the object used to synchronize queue access
long	getTimeout() Retrieves the timeout used by the reader
TimeUnit	getTimeUnit() Retrieves the time unit of the timeout used by the reader
boolean	isActive() Checks if the current ScanElement is active
void	setActive(boolean active) Sets if the current ScanElement is active
void	setCounter(long counter) Sets the counter of this ScanElement
void	setFileBuf(DiskBuffer fileBuf) Sets the file buffer
void	setInputID(short inputID) Sets the input id of this ScanElement
void	setMetaInputID(short metaInputID) Sets the metadata input id of this ScanElement
void	setQueue(Queue<JoinElement> queue) Sets the queue used to place records
void	setReader(gr.uoa.di.madgik.grs.reader.ForwardReader<gr.uoa.di.madgik.grs.record.Record> reader) Sets the RSXMLIterator
void	setSynchThis(Object synchThis) Sets the object used to synchronize queue access
void	setTimeout(long timeout) Sets the timeout used by the reader
void	setTimeUnit(TimeUnit timeUnit) Sets the time unit of the timeout used by the reader

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanElement

public ScanElement(gr.uoa.di.madgik.grs.reader.ForwardReader<gr.uoa.di.madgik.grs.record.Record> reader,
                   Queue<JoinElement> queue,
                   Object synchThis,
                   short inputID,
                   short metaInputID,
                   long timeout,
                   TimeUnit timeUnit)

Create a new ScanElement

Parameters:

reader - Input reader

queue - The queue to place extacted records

synchThis - Used for queue synchronization

inputID - Used to separate the various ScanElement instances based on their collection

metaInputID - Used to separate the various ScanElement instances of a collection based on which content/metadata collections they belong

Method Detail

getCounter

public long getCounter()

Retrieves the counter for this ScanElement

Returns:

The counter

setCounter

public void setCounter(long counter)

Sets the counter of this ScanElement

Parameters:

counter - The counter

getInputID

public short getInputID()

Retrieves the input id of this ScanElement

Returns:

The input ID

setInputID

public void setInputID(short inputID)

Sets the input id of this ScanElement

Parameters:

inputID - The input id

getMetaInputID

public short getMetaInputID()

Retrieves the metadata input id of this ScanElement

Returns:

The input ID

setMetaInputID

public void setMetaInputID(short metaInputID)

Sets the metadata input id of this ScanElement

Parameters:

inputID - The input id

isActive

public boolean isActive()

Checks if the current ScanElement is active

Returns:

true if it is, false otherwise

setActive

public void setActive(boolean active)

Sets if the current ScanElement is active

Parameters:

active - true if it is, false otherwise

getFileBuf

public DiskBuffer getFileBuf()

Retrieves the file buffer

Returns:

The file buffer

setFileBuf

public void setFileBuf(DiskBuffer fileBuf)

Sets the file buffer

Parameters:

fileBuf - The file buffer

getReader

public gr.uoa.di.madgik.grs.reader.ForwardReader<gr.uoa.di.madgik.grs.record.Record> getReader()

Retrieves the RSXMLIterator

Returns:

The iterator

setReader

public void setReader(gr.uoa.di.madgik.grs.reader.ForwardReader<gr.uoa.di.madgik.grs.record.Record> reader)

Sets the RSXMLIterator

Parameters:

iter - The iterator

getQueue

public Queue<JoinElement> getQueue()

Retrieves the queue used to place records

Returns:

The queue

setQueue

public void setQueue(Queue<JoinElement> queue)

Sets the queue used to place records

Parameters:

queue - The queue

getSynchThis

public Object getSynchThis()

Retrieves the object used to synchronize queue access

Returns:

The object to use

setSynchThis

public void setSynchThis(Object synchThis)

Sets the object used to synchronize queue access

Parameters:

synchThis - The object to use

getTimeout

public long getTimeout()

Retrieves the timeout used by the reader

Returns:

the timeout

setTimeout

public void setTimeout(long timeout)

Sets the timeout used by the reader

Parameters:

timeout - the timeout

getTimeUnit

public TimeUnit getTimeUnit()

Retrieves the time unit of the timeout used by the reader

Returns:

the time unit of the timeout

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

Sets the time unit of the timeout used by the reader

Parameters:

timeUnit - the unit of the timeout