oracle.toplink.xml
Class XMLReadAllCall

java.lang.Object
  |
  +--oracle.toplink.sdk.AbstractSDKCall
        |
        +--oracle.toplink.xml.XMLCall
              |
              +--oracle.toplink.xml.XMLReadAllCall

All Implemented Interfaces:

Call, java.lang.Cloneable, SDKCall, java.io.Serializable

public class XMLReadAllCall

extends XMLCall

XMLReadAllCall can perform one of two types of read:

1. Read all the XML documents for a given root element name.
2. Read the XML documents for a given set of foreign keys, specified by a 1:n mapping relationship.

Since:

TOPLink/Java 3.0

See Also:

SDKObjectCollectionMapping, Serialized Form

Constructor Summary

XMLReadAllCall()
Default constructor.

XMLReadAllCall(SDKObjectCollectionMapping mapping)
Constructor.

Method Summary

java.lang.Object	execute(DatabaseRow translationRow, oracle.toplink.internal.databaseaccess.Accessor accessor) Read and return the necessary rows of data.
void	setMapping(SDKObjectCollectionMapping mapping) Set the mapping the call fetches data for.

Methods inherited from class oracle.toplink.xml.XMLCall

getStreamPolicy, getXMLTranslator, setFile, setFile, setFileName, setFileName, setFiles, setFiles, setReader, setReaders, setStreamPolicy, setWriter, setXMLTranslator

Methods inherited from class oracle.toplink.sdk.AbstractSDKCall

addReadTranslation, addReadTranslations, addReadTranslations, addWriteTranslation, addWriteTranslations, addWriteTranslations, buildDefaultTranslator, buildNewQueryMechanism, buildQueryMechanism, clone, clone, getFieldTranslator, getLogString, isFinished, setFieldTranslator, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLReadAllCall

public XMLReadAllCall()

Default constructor.

XMLReadAllCall

public XMLReadAllCall(SDKObjectCollectionMapping mapping)

Constructor. Specify the associated mapping.

Method Detail

execute

public java.lang.Object execute(DatabaseRow translationRow,
                                oracle.toplink.internal.databaseaccess.Accessor accessor)
                         throws XMLDataStoreException

Read and return the necessary rows of data. If the mapping is missing, this call will simply read *all* the XML documents. If the mapping is present, this call will read all the XML documents for the keys specified in the "nested" rows.

XMLDataStoreException

setMapping

public void setMapping(SDKObjectCollectionMapping mapping)

Set the mapping the call fetches data for.