Module org.eclipse.persistence.nosql

Package org.eclipse.persistence.internal.eis.adapters.xmlfile

Class XMLFileInteraction

java.lang.Object

org.eclipse.persistence.internal.eis.adapters.xmlfile.XMLFileInteraction

All Implemented Interfaces:

Interaction

public class XMLFileInteraction
extends Object
implements Interaction

Interaction to XML file JCA adapter. Executes the interaction spec against the file and DOM.

Since:

OracleAS TopLink 10g (10.0.3)

Field Summary

Fields

Modifier and Type	Field	Description
protected XMLFileConnection	connection	Store the connection the interaction was created from.

Constructor Summary

Constructors

Constructor	Description
XMLFileInteraction(XMLFileConnection connection)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected DatabaseField	buildField(XMLFileInteractionSpec spec)	INTERNAL: All values are printed as ? to allow for parameter binding or translation during the execute of the call.
void	clearWarnings()
void	close()
Record	execute(InteractionSpec spec, Record input)	Execute the interaction spec.
boolean	execute(InteractionSpec spec, Record input, Record output)	Execute the interaction and set the output into the output record.
Record	executeDelete(XMLFileInteractionSpec spec, File file)	Execute the delete operation.
Record	executeInsert(XMLFileInteractionSpec spec, File file, EISDOMRecord input)	Execute the insert operation.
Record	executeRead(XMLFileInteractionSpec spec, File file)	Execute the read operation.
Record	executeUpdate(XMLFileInteractionSpec spec, File file, EISDOMRecord input)	Execute the update operation.
Connection	getConnection()
ResourceWarning	getWarnings()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

connection

protected XMLFileConnection connection

Store the connection the interaction was created from.

Constructor Details

XMLFileInteraction

public XMLFileInteraction(XMLFileConnection connection)

Default constructor.

Method Details

clearWarnings

public void clearWarnings()

Specified by:

clearWarnings in interface Interaction

close

public void close()

Specified by:

close in interface Interaction

execute

public Record execute(InteractionSpec spec,
 Record input)
               throws ResourceException

Execute the interaction spec. The spec define the type of CRUD operation and the file/DOM to perform it on. The spec may also contain and XQuery/XPath to evaluate against the DOM. The input is used for insert/update to contain the data (DOM) to insert into the file.

Specified by:

execute in interface Interaction

Throws:

ResourceException

executeRead

public Record executeRead(XMLFileInteractionSpec spec,
 File file)
                   throws Exception

Execute the read operation.

Throws:

Exception

executeInsert

public Record executeInsert(XMLFileInteractionSpec spec,
 File file,
 EISDOMRecord input)
                     throws Exception

Execute the insert operation.

Throws:

Exception

executeUpdate

public Record executeUpdate(XMLFileInteractionSpec spec,
 File file,
 EISDOMRecord input)
                     throws Exception

Execute the update operation.

Throws:

Exception

executeDelete

public Record executeDelete(XMLFileInteractionSpec spec,
 File file)
                     throws Exception

Execute the delete operation.

Throws:

Exception

execute

public boolean execute(InteractionSpec spec,
 Record input,
 Record output)
                throws ResourceException

Execute the interaction and set the output into the output record. Return true or false if the execute returned data (similar to row-count).

Specified by:

execute in interface Interaction

Throws:

ResourceException

getConnection

public Connection getConnection()

Specified by:

getConnection in interface Interaction

getWarnings

public ResourceWarning getWarnings()

Specified by:

getWarnings in interface Interaction

buildField

protected DatabaseField buildField(XMLFileInteractionSpec spec)

INTERNAL: All values are printed as ? to allow for parameter binding or translation during the execute of the call.