ptdb.common.dto

Class SetupParameters

java.lang.Object

ptdb.common.dto.SetupParameters

public class SetupParameters
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:

Yousef Alsaeed

Pt.AcceptedRating:

Red (yalsaeed)

Pt.ProposedRating:

Red (yalsaeed)

Constructor Summary

Constructors

Constructor and Description
SetupParameters(java.lang.String url, java.lang.String containerName, java.lang.String cacheContainerName) Construct an instance with the given parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCacheContainerName() Return the cache container name.
java.lang.String	getContainerName() Return the container name.
java.lang.String	getUrl() Return the URL/path of the location where the XML database file is present.
void	setCacheContainerName(java.lang.String cacheContainerName) Set the cache container name parameter to the given name.
void	setContainerName(java.lang.String containerName) Set the container name 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

SetupParameters

public SetupParameters(java.lang.String url,
                       java.lang.String containerName,
                       java.lang.String cacheContainerName)

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.

cacheContainerName - Name of the cache container for the XML Database.

Method Detail

getCacheContainerName

public java.lang.String getCacheContainerName()

Return the cache container name.

Returns:

The cache container name.

See Also:

setCacheContainerName(java.lang.String)

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)

setCacheContainerName

public void setCacheContainerName(java.lang.String cacheContainerName)

Set the cache container name parameter to the given name.

Parameters:

cacheContainerName - The cache container name.

See Also:

getCacheContainerName()

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()

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()