Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.xml
Class XMLDataCall

java.lang.Object
  extended byoracle.toplink.sdk.AbstractSDKCall
      extended byoracle.toplink.xml.XMLCall
          extended byoracle.toplink.xml.XMLDataCall

All Implemented Interfaces:
Call, java.lang.Cloneable, SDKCall, java.io.Serializable
Direct Known Subclasses:
XMLDataDeleteCall, XMLDataReadCall, XMLDataWriteCall

public abstract class XMLDataCall
extends XMLCall

XMLDataCall provides the base state and behavior for XML calls that will read or write raw data, as opposed to objects. It provides a way to specify the "root element"/"document"/"table" and the necessary primary key. The derivative classes of XMLDataCall will use the state in this class for primary key and root element/table information. The other corresponding calls in this package (e.g. XMLDataReadCall corresponds to XMLReadCall) get this information from the descriptor.

Since:
TOPLink/Java 3.0
See Also:
Serialized Form

Constructor Summary
XMLDataCall()
Default constructor.

Method Summary
void addPrimaryKeyElementName(java.lang.String primaryKeyElementName)
Add a primary key element name.
void setPrimaryKeyElementName(java.lang.String primaryKeyFieldName)
Set the name of the singular primary key element.
void setPrimaryKeyElementNames(java.lang.String[] primaryKeyElementNames)
Set the primary key element names.
void setPrimaryKeyElementNames(java.util.Vector primaryKeyElementNames)
Set the primary key element names.
void setRootElementName(java.lang.String rootElementName)
Set the root element name.

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

Methods inherited from interface oracle.toplink.sdk.SDKCall
execute

Constructor Detail

XMLDataCall

public XMLDataCall()
Default constructor.

Method Detail

addPrimaryKeyElementName

public void addPrimaryKeyElementName(java.lang.String primaryKeyElementName)
Add a primary key element name. The order in which these names are added may be significant.

setPrimaryKeyElementName

public void setPrimaryKeyElementName(java.lang.String primaryKeyFieldName)
Set the name of the singular primary key element.

setPrimaryKeyElementNames

public void setPrimaryKeyElementNames(java.lang.String[] primaryKeyElementNames)
Set the primary key element names. The order may be significant.

setPrimaryKeyElementNames

public void setPrimaryKeyElementNames(java.util.Vector primaryKeyElementNames)
Set the primary key element names. The order may be significant.

setRootElementName

public void setRootElementName(java.lang.String rootElementName)
Set the root element name.

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.