ptdb.common.dto

Class DBConnectionParameters

java.lang.Object

ptdb.common.dto.DBConnectionParameters

public class DBConnectionParameters
extends java.lang.Object

Encapsulate the parameters required for creating an XML DB connection.

The Data Transfer Object pattern is used here.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Ashwini Bijwe

Pt.AcceptedRating:

Red (abijwe)

Pt.ProposedRating:

Red (abijwe)

Constructor Summary

Constructors

Constructor and Description
DBConnectionParameters(java.lang.String url, java.lang.String containerName, boolean isTransactionRequired) Construct an instance with the given parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContainerName() Return the container name for the given XML database.
java.lang.String	getUrl() Return the URL/path of the location where the XML database file is present.
boolean	isTransactionRequired() Return true if the connection is to be created with transaction and false if it is to be created without transaction.
void	setContainerName(java.lang.String containerName) Set the container name parameter to the given value.
void	setIsTransactionRequired(boolean isTransactionRequired) Set the transaction required parameter to the given value.
void	setUrl(java.lang.String url) Set the URL parameter to the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBConnectionParameters

public DBConnectionParameters(java.lang.String url,
                              java.lang.String containerName,
                              boolean isTransactionRequired)

Construct an instance with the given parameters.

Parameters:

url - Url/Path for the location where the database file is present

containerName - Name of the container for the XML Database.

isTransactionRequired - To specify whether the transaction management is required for the connection that is created.

Method Detail

getContainerName

public java.lang.String getContainerName()

Return the container name for the given XML database.

Returns:

The container name.

See Also:

setContainerName(java.lang.String)

getUrl

public java.lang.String getUrl()

Return the URL/path of the location where the XML database file is present.

Returns:

The database url.

See Also:

setUrl(java.lang.String)

isTransactionRequired

public boolean isTransactionRequired()

Return true if the connection is to be created with transaction and false if it is to be created without transaction.

Returns:

True if transaction is required, false otherwise.

setContainerName

public void setContainerName(java.lang.String containerName)

Set the container name parameter to the given value.

Parameters:

containerName - Name of the container for the given XML database.

See Also:

getContainerName()

setIsTransactionRequired

public void setIsTransactionRequired(boolean isTransactionRequired)

Set the transaction required parameter to the given value.

Parameters:

isTransactionRequired - To specify whether the transaction management is required for the connection that is created.

setUrl

public void setUrl(java.lang.String url)

Set the URL parameter to the given value.

Parameters:

url - Location where the database file is present.

See Also:

getUrl()