Package com.orientechnologies.orient.core.fetch

Interface OFetchListener

All Known Implementing Classes:

OJSONFetchListener, ORemoteFetchListener

public interface OFetchListener

Listener interface used while fetching records.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Method Summary

Modifier and Type	Method	Description
Object	fetchLinked(ODocument iRoot, Object iUserObject, String iFieldName, ODocument iLinked, OFetchContext iContext)	Fetch the linked field.
Object	fetchLinkedCollectionValue(ODocument iRoot, Object iUserObject, String iFieldName, ODocument iLinked, OFetchContext iContext)
Object	fetchLinkedMapEntry(ODocument iRoot, Object iUserObject, String iFieldName, String iKey, ODocument iLinked, OFetchContext iContext)
void	parseLinked(ODocument iRootRecord, OIdentifiable iLinked, Object iUserObject, String iFieldName, OFetchContext iContext)
void	parseLinkedCollectionValue(ODocument iRootRecord, OIdentifiable iLinked, Object iUserObject, String iFieldName, OFetchContext iContext)
void	processStandardField(ODocument iRecord, Object iFieldValue, String iFieldName, OFetchContext iContext, Object iUserObject, String iFormat, OType filedType)
boolean	requireFieldProcessing()	Returns true if the listener fetches he fields.
void	skipStandardField(ODocument iRecord, String iFieldName, OFetchContext iContext, Object iUserObject, String iFormat)

Method Details

requireFieldProcessing

boolean requireFieldProcessing()

Returns true if the listener fetches he fields.

fetchLinked

Object fetchLinked(ODocument iRoot,
 Object iUserObject,
 String iFieldName,
 ODocument iLinked,
 OFetchContext iContext)
            throws OFetchException

Fetch the linked field.

Parameters:

iRoot -

iFieldName -

iLinked -

Returns:

null if the fetching must stop, otherwise the current field value

Throws:

OFetchException

parseLinked

void parseLinked(ODocument iRootRecord,
 OIdentifiable iLinked,
 Object iUserObject,
 String iFieldName,
 OFetchContext iContext)
          throws OFetchException

Throws:

OFetchException

parseLinkedCollectionValue

void parseLinkedCollectionValue(ODocument iRootRecord,
 OIdentifiable iLinked,
 Object iUserObject,
 String iFieldName,
 OFetchContext iContext)
                         throws OFetchException

Throws:

OFetchException

fetchLinkedMapEntry

Object fetchLinkedMapEntry(ODocument iRoot,
 Object iUserObject,
 String iFieldName,
 String iKey,
 ODocument iLinked,
 OFetchContext iContext)
                    throws OFetchException

Throws:

OFetchException

fetchLinkedCollectionValue

Object fetchLinkedCollectionValue(ODocument iRoot,
 Object iUserObject,
 String iFieldName,
 ODocument iLinked,
 OFetchContext iContext)
                           throws OFetchException

Throws:

OFetchException

processStandardField

void processStandardField(ODocument iRecord,
 Object iFieldValue,
 String iFieldName,
 OFetchContext iContext,
 Object iUserObject,
 String iFormat,
 OType filedType)
                   throws OFetchException

Throws:

OFetchException

skipStandardField

void skipStandardField(ODocument iRecord,
 String iFieldName,
 OFetchContext iContext,
 Object iUserObject,
 String iFormat)
                throws OFetchException

Throws:

OFetchException