Package com.netrics.likeit

Class NetricsTableCursorCompoundRecSrc

java.lang.Object

com.netrics.likeit.NetricsTableCursorCompoundRecSrc

All Implemented Interfaces:

NetricsBaseRecSrc, NetricsCompoundRecSrc

public class NetricsTableCursorCompoundRecSrc
extends java.lang.Object
implements NetricsCompoundRecSrc

Implements the NetricsCompoundRecSrc interface by binding a NetricsTableCursor to a particular ibi™ Patterns - Search server.

Constructor Summary

Constructors

Constructor	Description
NetricsTableCursorCompoundRecSrc(NetricsTableCursor cursor, NetricsServerInterface host)	Create a NetricsTableCursorCompoundRecSrc instance.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getChildTables()	Get an unmodifiable list of child table names used.
java.lang.Integer	getCount()	Get the count of records that have been retrieved from the record source.
NetricsCompoundRecord	getNext()	Returns the next record.
java.lang.String	getParentTable()
java.lang.String	getPosition()	Obtains the current position of the underlying cursor.
boolean	hasNext()	True if getNext will return a record.
void	reset()	Resets the underlying cursor to the beginning.
void	setPosition(java.lang.String position)	Reposition the underlying cursor.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetricsTableCursorCompoundRecSrc

public NetricsTableCursorCompoundRecSrc(NetricsTableCursor cursor,
                                        NetricsServerInterface host)

Create a NetricsTableCursorCompoundRecSrc instance.

Parameters:

cursor - cursor underlying the record source.

host - the cursor will traverse table(s) on this host.

Method Detail

hasNext

public boolean hasNext()
                throws NetricsRecSrcException

Description copied from interface: NetricsBaseRecSrc

True if getNext will return a record.

Specified by:

hasNext in interface NetricsBaseRecSrc

Returns:

True if there is another record, false otherwise

Throws:

NetricsRecSrcException - if an error occurs.

getNext

public NetricsCompoundRecord getNext()
                              throws NetricsRecSrcException

Description copied from interface: NetricsCompoundRecSrc

Returns the next record. We restrict the return value to NetricsCompoundRecord instead of the base NetricsBaseRecord.

Specified by:

getNext in interface NetricsBaseRecSrc

Specified by:

getNext in interface NetricsCompoundRecSrc

Returns:

the next record

Throws:

NetricsRecSrcException - if an error occurs, or if there are no more records.

reset

public void reset()

Resets the underlying cursor to the beginning.

Specified by:

reset in interface NetricsBaseRecSrc

getCount

public java.lang.Integer getCount()

Description copied from interface: NetricsBaseRecSrc

Get the count of records that have been retrieved from the record source.
Sources that don't support a count will return null.

Specified by:

getCount in interface NetricsBaseRecSrc

Returns:

The number of records that have been retrieved from the record source.

getPosition

public java.lang.String getPosition()

Obtains the current position of the underlying cursor. This position may be used to later set the cursor position using setPosition(java.lang.String).

Returns:

the current position of the underlying cursor.

setPosition

public void setPosition(java.lang.String position)

Reposition the underlying cursor.

Parameters:

position - a cursor position. This should be a value returned by getPosition()

getParentTable

public java.lang.String getParentTable()

Specified by:

getParentTable in interface NetricsCompoundRecSrc

Returns:

the parent/primary table name for the compound record.

getChildTables

public java.util.List<java.lang.String> getChildTables()

Get an unmodifiable list of child table names used. This list represents all possible child tables. A particular compound record returned may not contain child records for all of these tables.

Specified by:

getChildTables in interface NetricsCompoundRecSrc

Returns:

the list of child table names.

Returns null if

• (a) the underlying cursor has not has a list of child tables set via NetricsTableCursor.setChildTables(java.lang.String[]), and
• (b) the first batch of records has not been retrieved from the underlying cursor.