|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.co.agena.minerva.model.extendedbn.ExtendedNodeFunction
public class ExtendedNodeFunction
This class encapsulates a function used to define (in full or in part) the NPT for an ExtendedNode. ExtendedNodeFunctions can be fully specified or not fully specified. Whether they are or are not may be of interest to applications that need to display what information a user is required to provide.
Field Summary | |
---|---|
static int |
CURRENT_TYPE
Constant indicating that a function is the current one for an ExtendedNode. |
static int |
DEFAULT_TYPE
Constant indicating that a function is a default one. |
static char |
NEW_LINE_REPLACEMENT
When saving the parameters of an expression it is not possible to save user entered new lines as these adversly affect subsequent loading of the expression. |
Fields inherited from interface uk.co.agena.minerva.util.model.Writable |
---|
FIELD_SEPARATOR |
Constructor Summary | |
---|---|
ExtendedNodeFunction()
Default constructor. |
|
ExtendedNodeFunction(java.lang.String name,
java.util.List parameters)
Creates a new ExtendedNodeFunction with the supplied name and parameters. |
|
ExtendedNodeFunction(java.lang.String name,
java.util.List parameters,
int type)
Constructs an ExtendedNodeFunction with the supplied name, parameters and type. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Makes a copy of this ExtendedNodeFunction. |
java.lang.String |
getName()
Returns the name of this ExtendedNodeFunction. |
java.util.List |
getParameters()
Returns the parameters for this ExtendedNodeFunction without any user entered Tabs or New Lines. |
java.util.List |
getParametersWithFormatting()
Returns the parameters for this ExtendedNodeFunction with all user entered Tabs and New Lines. |
int |
getType()
Returns the type of this ExtendedNodeFunction. |
double |
getVersion()
Returns the version of the class. |
boolean |
isFullySpecified()
Returns whether the ExtendedNodeFunction is fully specified. |
int |
read(java.util.List strings,
int currentLineNumber)
|
void |
setName(java.lang.String name)
|
void |
setParameters(java.util.List parameters)
|
void |
setType(int type)
Sets the type of this ExtendedNodeFunction to the value specified. |
void |
setVersion(double version)
Sets the version number of the class. |
java.lang.String |
toString()
Returns a String representation of the ExtendedNodeFunction. |
void |
updateParameterStrings(java.lang.String oldFunctionName,
java.lang.String newFunctionName)
Updates the parameter strings with the new function name for the nodes involved. |
java.util.List |
write()
Writes the object in question to a List of Strings. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_TYPE
public static final int CURRENT_TYPE
public static final char NEW_LINE_REPLACEMENT
Constructor Detail |
---|
public ExtendedNodeFunction()
public ExtendedNodeFunction(java.lang.String name, java.util.List parameters)
name
- parameters
- public ExtendedNodeFunction(java.lang.String name, java.util.List parameters, int type)
name
- the name of the ExtendedNodeFunctionparameters
- the parameters for the ExtendedNodeFunctiontype
- the type of the ExtendedNodeFunction (DEFAULT_TYPE or
CURRENT_TYPE)Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String name)
public void setParameters(java.util.List parameters)
public double getVersion()
Writable
getVersion
in interface Writable
public void setVersion(double version)
Writable
setVersion
in interface Writable
version
- the version numberpublic java.util.List getParameters()
public java.util.List getParametersWithFormatting()
public boolean isFullySpecified()
public int getType()
public void updateParameterStrings(java.lang.String oldFunctionName, java.lang.String newFunctionName)
oldFunctionName
- newFunctionName
- public void setType(int type)
type
- the new type of this ExtendedNodeFunction (DEFAULT_TYPE or
CURRENT_TYPE)public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.List write() throws MinervaReadWriteException
Writable
write
in interface Writable
MinervaReadWriteException
- if therepublic int read(java.util.List strings, int currentLineNumber) throws MinervaReadWriteException
read
in interface Writable
MinervaReadWriteException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |