com.denodo.itpilot.client

Class HTMLWrapperResultIterator

java.lang.Object

com.denodo.itpilot.client.HTMLWrapperResultIterator

All Implemented Interfaces:

Iterator

public class HTMLWrapperResultIterator
extends Object
implements Iterator

Ayncronous iterator over the results of a wrapper query. The objects of this class are obtained through the query method of the HTMLWrapperProxy class.

Constructor Summary

Constructors

Constructor and Description
HTMLWrapperResultIterator(com.denodo.vdb.vdbinterface.client.util.iterator.VDBResultSetIterator iterator) Constructs a HTMLWrapperResultIterator object over the given VDBResultSetIterator object.
HTMLWrapperResultIterator(com.denodo.vdb.vdbinterface.client.util.iterator.VDBResultSetIterator iterator, com.denodo.vdb.vdbinterface.common.connection.VDBConnection conn) Constructs a HTMLWrapperResultIterator object over the given VDBResultSetIterator object and the VDBConnection object.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the execution query.
boolean	checkErrors() Returns true if any error occurred during the iterator execution.
void	close() Closes the Wrapper Server connection used by the iterator.
String	getErrorDescription() Describes the errors ocurred during the iterator execution.
com.denodo.vdb.vdbinterface.common.clientResult.MetadataField[]	getSchema()
List<Object>	getTraceEvents() Returns the records added to the execution plan through the TRACE action.
boolean	hasNext() Indicates if there are more results.
Object	next() Obtains the next result.
void	remove() This method is not implemented.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

HTMLWrapperResultIterator

public HTMLWrapperResultIterator(com.denodo.vdb.vdbinterface.client.util.iterator.VDBResultSetIterator iterator)

Constructs a HTMLWrapperResultIterator object over the given VDBResultSetIterator object.

Parameters:

iterator - the Wrapper Server iterator with the results of a wrapper query.

HTMLWrapperResultIterator

public HTMLWrapperResultIterator(com.denodo.vdb.vdbinterface.client.util.iterator.VDBResultSetIterator iterator,
                                 com.denodo.vdb.vdbinterface.common.connection.VDBConnection conn)

Constructs a HTMLWrapperResultIterator object over the given VDBResultSetIterator object and the VDBConnection object.

Parameters:

iterator - the Wrapper Server iterator with the results of a wrapper query.

conn - VDB Connection used in cancel() operation.

Method Detail

cancel

public void cancel()
            throws UnsupportedOperationException

Cancel the execution query.

Throws:

UnsupportedOperationException - if the connection is null.

remove

public void remove()
            throws UnsupportedOperationException

This method is not implemented.

Specified by:

remove in interface Iterator

Throws:

UnsupportedOperationException

See Also:

Iterator.remove()

getSchema

public com.denodo.vdb.vdbinterface.common.clientResult.MetadataField[] getSchema()

hasNext

public boolean hasNext()

Indicates if there are more results.

Specified by:

hasNext in interface Iterator

Returns:

true if there are more results.

See Also:

Iterator.hasNext()

next

public Object next()
            throws NoSuchElementException

Obtains the next result. Each result will be an object of type StandardRowVO, which encapsulates a Map with one entry for each field of the result. The keys will be the names of the fields and the values objects of type ValueVO. A ValueVO can be a simple value (SimpleVO), an array value (ArrayVO), or a register value (RegisterVO).

Specified by:

next in interface Iterator

Returns:

the next result.

Throws:

NoSuchElementException

See Also:

Iterator.next()

checkErrors

public boolean checkErrors()

Returns true if any error occurred during the iterator execution.

Returns:

true if any error occurred, false otherwise.

getErrorDescription

public String getErrorDescription()

Describes the errors ocurred during the iterator execution.

Returns:

a String containing the description of the errors occurred during the iterator execution. Returns null if no errors occurred.

getTraceEvents

public List<Object> getTraceEvents()

Returns the records added to the execution plan through the TRACE action. The TRACE action could be configured in each component of the wrapper to add a record to the VDP execution plan when an error occurs in the component. These errors does not finish the wrapper execution unless the RAISE handler were configured.

Returns:

a list of records, List