public interface DataSet extends NamedType
DataSetImpl
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATEND |
static java.lang.String |
DATASETTAG |
static java.lang.String |
DS_MAX_ITEMS |
static java.lang.String |
LOCAL |
static java.lang.String |
NAME |
static java.lang.String |
RANDOM |
static java.lang.String |
READAREC |
static java.lang.String |
SAMPLE_PROPS |
static java.lang.String |
TYPE |
Modifier and Type | Method and Description |
---|---|
void |
baseInit(org.w3c.dom.Element dataset)
This method is called to setup the properties of every data set.
|
void |
cancelProcessing()
Called by the DataSetBaseInfoEditor to cancel current processing.
|
void |
destroy()
Called by the framework to give you a chance to clean up after youself, like
close your DB connection!
|
java.lang.String |
getAtend()
The AtEnd is the node that should be executed when their are no more rows
in the result set of this data set.
|
java.lang.String |
getName()
Called for the obvious purpose of getting the name of this data set.
|
ParameterList |
getParameters()
For any DataSet, this method will return all the attributes of that object
Basically, every non-transient type state value (name, type, atend) and
whatever custom properties there are (like location and delimiter)
|
java.util.Map<java.lang.String,?> |
getRecord(java.util.Map<java.io.Serializable,java.io.Serializable> testState)
This is the method called by the TestNode class in order to do a logical
read on the data set so that the specific property settings of this
data set record are reflected in the caller's state.
|
java.lang.String |
getType()
Returns the classname of the class implementing this interface.
|
void |
initialize(org.w3c.dom.Element dataset,
java.util.Map<java.lang.String,?> tcProps)
Called during test case construction to read the XML document data that is
specific to this kind of data set.
|
void |
initialize(ParameterList params,
TestExec ts)
This is an alternative to getting one of these made by building a ParameterList instead
of giving us an XML Element.
|
boolean |
isCanceled() |
boolean |
isLocal()
If a data set is local then it is instanced for every test exec individually, not as a "globally-scoped"
object
|
void |
reset()
Called by the framework when a property name "lisa." + getName() + ".reset" is set == true
The dataset should "reset" itself to its initial state and begin reading from the beginning.
|
void |
setAtend(java.lang.String atend)
Sets the AtEnd attribute for this data set.
|
void |
setName(java.lang.String name)
Sets the name for this data set.
|
void |
validateData(java.util.Map<java.io.Serializable,java.io.Serializable> testState)
Called by the DataSetBaseInfoEditor to perform validation.
|
void |
writeXML(java.io.PrintWriter pw)
We write XML just like the next guy, but because we are a Remote object we can't do it
w/o having to throw RemoteException from the Interface, so we just happen to have the same method
|
getTypeName
static final java.lang.String NAME
static final java.lang.String TYPE
static final java.lang.String ATEND
static final java.lang.String LOCAL
static final java.lang.String RANDOM
static final java.lang.String DS_MAX_ITEMS
static final java.lang.String SAMPLE_PROPS
static final java.lang.String READAREC
static final java.lang.String DATASETTAG
void baseInit(org.w3c.dom.Element dataset) throws java.rmi.RemoteException, TestDefException
dataset
- - this is the DOM object for the data setjava.rmi.RemoteException
TestDefException
initialize(org.w3c.dom.Element,java.util.Map)
void initialize(org.w3c.dom.Element dataset, java.util.Map<java.lang.String,?> tcProps) throws java.rmi.RemoteException, TestDefException
dataset
- - this is the DOM object for the data settcProps
- java.rmi.RemoteException
TestDefException
void initialize(ParameterList params, TestExec ts) throws java.rmi.RemoteException, TestDefException
params
- parameters to usets
- TestExec used for parsing in propsjava.rmi.RemoteException
TestDefException
java.util.Map<java.lang.String,?> getRecord(java.util.Map<java.io.Serializable,java.io.Serializable> testState) throws java.rmi.RemoteException, TestRunException
java.rmi.RemoteException
TestRunException
java.lang.String getName() throws java.rmi.RemoteException
java.rmi.RemoteException
void setName(java.lang.String name) throws java.rmi.RemoteException
name
- new name of the data setjava.rmi.RemoteException
java.lang.String getAtend() throws java.rmi.RemoteException
java.rmi.RemoteException
for an explanation of AtEnd
void setAtend(java.lang.String atend) throws java.rmi.RemoteException
atend
- the node name or nulljava.rmi.RemoteException
void destroy() throws java.rmi.RemoteException
java.rmi.RemoteException
boolean isLocal() throws java.rmi.RemoteException
java.rmi.RemoteException
ParameterList getParameters() throws java.rmi.RemoteException
java.rmi.RemoteException
void reset() throws java.rmi.RemoteException
java.rmi.RemoteException
void cancelProcessing() throws java.rmi.RemoteException
java.rmi.RemoteException
boolean isCanceled() throws java.rmi.RemoteException
java.rmi.RemoteException
void validateData(java.util.Map<java.io.Serializable,java.io.Serializable> testState) throws java.rmi.RemoteException, TestRunException
testState
- java.rmi.RemoteException
TestRunException
void writeXML(java.io.PrintWriter pw) throws java.rmi.RemoteException
pw
- streamjava.rmi.RemoteException
java.lang.String getType() throws java.rmi.RemoteException
obj.getClass().getName()
for the classname because,
if obj
is an RMI handle, then obj.getClass().getName()
returns
something like , which offers no help in determining the ControllerBase
that pairs with this DataSet.java.rmi.RemoteException
Copyright © 1998-2014 CA, Inc. All Rights Reserved.