Module org.eclipse.persistence.nosql

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

Class XMLFileInteractionSpec

java.lang.Object

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

All Implemented Interfaces:

InteractionSpec, Serializable

public class XMLFileInteractionSpec
extends Object
implements InteractionSpec

Interaction spec for XML file JCA adapter. Supports CRUD access to an XML file based on XPath and XQuery. Also supports in-memory DOM access.

Since:

OracleAS TopLink 10g (10.0.3)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DELETE
protected Element	dom
protected String	fileName
static final int	INSERT	Type constants for defining interaction type.
protected int	interactionType
protected NamespaceResolver	namespaceResolver
static final int	READ
static final int	UPDATE
protected String	xPath
protected String	xQuery

Fields inherited from interface jakarta.resource.cci.InteractionSpec

SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE

Constructor Summary

Constructors

Constructor	Description
XMLFileInteractionSpec()	Default constructor.
XMLFileInteractionSpec(NamespaceResolver namespaceResolver)

Method Summary

Modifier and Type	Method	Description
Element	getDOM()	Return the XML DOM element to be accessed directly.
String	getFileName()	Return the name of file to be accessed.
int	getInteractionType()	Return the CRUD interaction type of the interaction.
NamespaceResolver	getNamespaceResolver()	Return the namespaceResolver to be used to resolve any namespace prefixes in the XPath.
String	getXPath()	Return the path to the element within the document to be accessed.
String	getXQuery()	Return the query to the element within the document to be accessed.
void	setDOM(Element dom)	Set the XML DOM element to be accessed directly.
void	setFileName(String fileName)	Set the name of file to be accessed.
void	setInteractionType(int interactionType)	Set the CRUD interaction type of the interaction.
void	setNamespaceResolver(NamespaceResolver namespaceResolver)	Return the namespaceResolver to be used to resolve any namespace prefixes in the XPath.
void	setXPath(String xPath)	Set the path to the element within the document to be accessed.
void	setXQuery(String xQuery)	Set the query to the element within the document to be accessed.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

namespaceResolver

protected transient NamespaceResolver namespaceResolver

xPath

protected String xPath

xQuery

protected String xQuery

interactionType

protected int interactionType

fileName

protected String fileName

dom

protected transient Element dom

INSERT

public static final int INSERT

Type constants for defining interaction type.

See Also:

• Constant Field Values

READ

public static final int READ

See Also:

• Constant Field Values

UPDATE

public static final int UPDATE

See Also:

• Constant Field Values

DELETE

public static final int DELETE

See Also:

• Constant Field Values

Constructor Details

XMLFileInteractionSpec

public XMLFileInteractionSpec()

Default constructor.

XMLFileInteractionSpec

public XMLFileInteractionSpec(NamespaceResolver namespaceResolver)

Method Details

getXPath

public String getXPath()

Return the path to the element within the document to be accessed.

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()

Return the namespaceResolver to be used to resolve any namespace prefixes in the XPath.

setNamespaceResolver

public void setNamespaceResolver(NamespaceResolver namespaceResolver)

Return the namespaceResolver to be used to resolve any namespace prefixes in the XPath.

setXPath

public void setXPath(String xPath)

Set the path to the element within the document to be accessed.

getXQuery

public String getXQuery()

Return the query to the element within the document to be accessed.

setXQuery

public void setXQuery(String xQuery)

Set the query to the element within the document to be accessed.

getInteractionType

public int getInteractionType()

Return the CRUD interaction type of the interaction.

setInteractionType

public void setInteractionType(int interactionType)

Set the CRUD interaction type of the interaction.

getFileName

public String getFileName()

Return the name of file to be accessed.

setFileName

public void setFileName(String fileName)

Set the name of file to be accessed.

getDOM

public Element getDOM()

Return the XML DOM element to be accessed directly. This can be used for in-memory DOM access.

setDOM

public void setDOM(Element dom)

Set the XML DOM element to be accessed directly. This can be used for in-memory DOM access.

toString

public String toString()

Overrides:

toString in class Object