com.sl.gmsjrtviewds
Class GmsRtViewDsBaseProperties

java.lang.Object
  com.sl.gmsjrtviewds.GmsRtViewDsBaseProperties

All Implemented Interfaces:

java.lang.Cloneable

public class GmsRtViewDsBaseProperties
extends java.lang.Object
implements java.lang.Cloneable

This class contains base metadata that describes an Enterprise RTView Data Adapter, including descriptive information and the names of auxiliary classes and files. The base properties are set during initialization, in the method GmsRtViewDs.initDsBaseProperties(), and cannot be changed after initialization is complete. Note that the base properties are set from the GmsRtViewDs constructor, before any command-line arguments or ds options have been processed.

Method Summary

protected java.lang.Object	clone()
java.lang.String	getAdapterClassName() Get the name of the adapter class for this datasource.
java.lang.String	getDsDescription() Get the description string associated with this datasource.
java.lang.String	getDsKey() Get the key string associated with this datasource.
java.lang.String	getOptionFileName() Get the name of the option file to read/write for this datasource.
void	setAdapterClassName(java.lang.String className) Set the name of the adapter class for this datasource.
void	setDsDescription(java.lang.String dsDescription) Set the description string associated with this datasource.
void	setDsKey(java.lang.String dsKey) Set the key string associated with this datasource.
void	setOptionFileName(java.lang.String fileName) Set the name of the option file to read/write for this datasource.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getAdapterClassName

public java.lang.String getAdapterClassName()

Get the name of the adapter class for this datasource. The adapter handles the run-time connections to external data. All custom datasources must provide an adapter class.

Returns:

the class name of the adapter

getDsDescription

public java.lang.String getDsDescription()

Get the description string associated with this datasource. The ds description is a short descriptive string which is added to the "about" dialog when this datasource is available.

Returns:

the datasource description

getDsKey

public java.lang.String getDsKey()

Get the key string associated with this datasource. The ds key is a unique identifier which is added to the beginning of all data attachments (dsStrings) for this datasource.

Returns:

the datasource key

getOptionFileName

public java.lang.String getOptionFileName()

Get the name of the option file to read/write for this datasource. DS options and connection strings are stored in this file. If this method returns null, the default custom ds option file will be used.

Returns:

the name of the option file

setAdapterClassName

public void setAdapterClassName(java.lang.String className)

Set the name of the adapter class for this datasource. The adapter handles the run-time connections to external data. All custom datasources must provide an adapter class.

Parameters:

className - the class name of the adapter

setDsDescription

public void setDsDescription(java.lang.String dsDescription)

Set the description string associated with this datasource. The ds description is a short descriptive string which is added to the "about" dialog when this datasource is available.

Parameters:

dsDescription - the datasource description

setDsKey

public void setDsKey(java.lang.String dsKey)

Set the key string associated with this datasource. The ds key is a unique identifier which is added to the beginning of all data attachments (dsStrings) for this datasource.

Parameters:

dsKey - the datasource key

setOptionFileName

public void setOptionFileName(java.lang.String fileName)

Set the name of the option file to read/write for this datasource. DS options and connection strings are stored in this file. If the fileName is null, the default custom ds option file will be used.

Parameters:

fileName - the name of the option file

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object