oracle.toplink.xml
Class XMLReadCall

java.lang.Object
oracle.toplink.sdk.AbstractSDKCall
oracle.toplink.xml.XMLCall
oracle.toplink.xml.XMLReadCall

All Implemented Interfaces:

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

public class XMLReadCall

extends XMLCall

XMLReadCall can perform one of two types of read:

1. Read the XML document for a given primary key.
2. Read the XML document for a given foreign key, specified by a 1:1 mapping relationship.

Since:

TOPLink/Java 3.0

See Also:

OneToOneMapping, Serialized Form

Constructor Summary

XMLReadCall()
Default constructor.

XMLReadCall(OneToOneMapping 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(OneToOneMapping 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

XMLReadCall

public XMLReadCall()

Default constructor.

XMLReadCall

public XMLReadCall(OneToOneMapping 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, the translation row holds the primary key for the data. If the mapping is present, the translation row holds a foreign key for the data.

Throws:

XMLDataStoreException

setMapping

public void setMapping(OneToOneMapping mapping)

Set the mapping the call fetches data for.