wt.workflow.definer
Class ProcessDataInfo

java.lang.Object
  extended bywt.workflow.definer.ProcessDataInfo
All Implemented Interfaces:
Evolvable, Externalizable, NetFactor, Serializable

public class ProcessDataInfo
extends Object
implements Externalizable, NetFactor, Evolvable

The ProcessDataInfo class provides information about the structure of ProcessData sets for the generated execution objects. It associates property names (variables) with their types and is used to generate ProcessData objects. The order in which the variables occur in the process data is relevant.

Each process data info object contains a vector with variable information. This is an uniform vector of WfVariableInfo objects in which no two WfVariableInfo objects can have the same name.

Use the newProcessDataInfo static factory method(s), not the ProcessDataInfo constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:
ProcessData, Serialized Form

Field Summary
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private  Vector variables
           
static String VARIABLES
          Label for the attribute.
 
Constructor Summary
ProcessDataInfo()
           
 
Method Summary
 void addOrReplaceVariableInfo(WfVariableInfo var_info)
          Replaces var info in the object with the same name as the one passed as argument.
 boolean addVariableInfo(WfVariableInfo var_info)
          Adds a variable info object.
 ProcessDataInfo copy()
          Produces a copy of the current object.
 Class[] getClassArray()
          Returns an array of the classes of the variables of the object.
 ClassInfo getClassInfo()
          Returns the ClassInfo object for this class.
 String getConceptualClassname()
          Deprecated.  
 int getNumberVariables()
          Returns the number of variables in the object.
 Enumeration getVariableEnum()
          Returns an enumeration (of type WfVariableInfo) of variable info objects contained in the current object.
 WfVariableInfo getVariableInfo(String name)
          Returns the variable info object associated with a variable name.
 WfVariableInfo[] getVariableList()
          Returns an array of WfVariableInfo containing the variables of the object.
 String[] getVariableNames()
          Returns a String array containing the names of the variables.
 Vector getVariables()
          Gets the object for the association that plays role: VARIABLES.
protected  void initialize()
          Supports initialization, following construction of an instance.
static ProcessDataInfo newProcessDataInfo()
          No-arg constructor.
private  void read981112L(ObjectInput input)
           
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
private  boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source, which is not the current version.
protected  boolean readVersion(ProcessDataInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 boolean removeVariableInfo(String name)
          Removes variable info of the name passed as argument.
 void setVariables(Vector a_Variables)
          Sets the object for the association that plays role: VARIABLES.
 String toString()
          Returns the conceptual (modeled) name for the class.
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

VARIABLES

public static final String VARIABLES
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

variables

private Vector variables

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID
See Also:
Constant Field Values
Constructor Detail

ProcessDataInfo

public ProcessDataInfo()
Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException
Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:
writeExternal in interface Externalizable
Parameters:
output -
Throws:
IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:
readExternal in interface Externalizable
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(ProcessDataInfo thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:
thisObject -
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException
Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Returns:
String

toString

public String toString()
Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:
String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException
Returns the ClassInfo object for this class.

Supported API: false

Specified by:
getClassInfo in interface NetFactor
Returns:
ClassInfo
Throws:
WTIntrospectionException

getVariables

public Vector getVariables()
Gets the object for the association that plays role: VARIABLES.

Supported API: false

Returns:
Vector

setVariables

public void setVariables(Vector a_Variables)
                  throws WTPropertyVetoException
Sets the object for the association that plays role: VARIABLES.

Supported API: false

Parameters:
a_Variables -
Throws:
WTPropertyVetoException

getVariableInfo

public WfVariableInfo getVariableInfo(String name)
Returns the variable info object associated with a variable name. Returns null if there no info object associated with the name passed as argument.

Supported API: false

Parameters:
name -
Returns:
WfVariableInfo

addVariableInfo

public boolean addVariableInfo(WfVariableInfo var_info)
                        throws WfException
Adds a variable info object. The method may fail if there is already a variable info obejct with the same name. Returns true if it succeeds, otherwise returns false. Throws InvalidVarInfoException if variable info passed as argument is not valid.

Supported API: false

Parameters:
var_info -
Returns:
boolean
Throws:
WfException

getClassArray

public Class[] getClassArray()
                      throws InvalidVariableInfoException
Returns an array of the classes of the variables of the object.

Supported API: false

Returns:
Class[]
Throws:
InvalidVariableInfoException

getVariableList

public WfVariableInfo[] getVariableList()
Returns an array of WfVariableInfo containing the variables of the object.

Supported API: true

Returns:
WfVariableInfo[]

newProcessDataInfo

public static ProcessDataInfo newProcessDataInfo()
                                          throws WTException
No-arg constructor.

Supported API: false

Returns:
ProcessDataInfo
Throws:
WTException

initialize

protected void initialize()
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Throws:
WTException

removeVariableInfo

public boolean removeVariableInfo(String name)
Removes variable info of the name passed as argument. Returns true if indeed the variable info was removed; false if there was no variable with this name.

Supported API: false

Parameters:
name -
Returns:
boolean

addOrReplaceVariableInfo

public void addOrReplaceVariableInfo(WfVariableInfo var_info)
                              throws InvalidVariableInfoException
Replaces var info in the object with the same name as the one passed as argument. Adds var info if no variable existed with the same name. Throws InvalidVarInfoException if variable info passed as argument is not valid.

Supported API: false

Parameters:
var_info -
Throws:
InvalidVariableInfoException

getNumberVariables

public int getNumberVariables()
Returns the number of variables in the object.

Supported API: false

Returns:
int

getVariableNames

public String[] getVariableNames()
Returns a String array containing the names of the variables.

Supported API: false

Returns:
String[]

getVariableEnum

public Enumeration getVariableEnum()
Returns an enumeration (of type WfVariableInfo) of variable info objects contained in the current object.

Supported API: false

Returns:
Enumeration

copy

public ProcessDataInfo copy()
Produces a copy of the current object.

Supported API: false

Returns:
ProcessDataInfo

read981112L

private void read981112L(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Throws:
IOException
ClassNotFoundException