| org.griphyn.vdl.classes.VDL
 org.griphyn.vdl.classes.Declare
| Declare | | public class Declare extends VDL implements Serializable(Code) | | This class defines the formal arguments to a Transformation.
author:
Jens-S. Vöckler
author:
Yong Zhao
version:
$Revision: 50 $
See Also: Transformation |
| Constructor Summary | |
| public | Declare()
| | public | Declare(String name, int ct)
ctor: Construct a new formal argument with a binding and default
container type. | | public | Declare(String name, int ct, int link)
ctor: Construct a new formal argument with a binding and default
container type, as well as a linkage for the argument. | | public | Declare(String name, Value value)
ctor: Construct a new formal argument with a binding and default
value. | | public | Declare(String name, Value value, int link)
ctor: Construct a new formal argument with a binding and default
value. |
| Method Summary | |
| public int | getContainerType()
Accessor: Obtains the container type. | | public int | getLink()
Accessor: Obtains the linkage type of the formal argument. | | public String | getName()
Accessor: Obtains the bound name of the formal argument. | | public Value | getValue()
Accessor: Obtains the optional default value for the parameter. | | public void | setContainerType(int containerType)
Accessor: Sets a new container type for the formal argument. | | public void | setLink(int link)
Accessor: Sets a new linkage type for the formal argument. | | public void | setName(String name)
Accessor: Establishes a new name with this formal argument to bind
to by an actual argument. | | public void | setValue(Value value)
Accessor: Sets or overwrites the optional default value of a formal
argument. | | public String | toString()
Dumps the content of the use element into a string for human consumption. | | public void | toString(Writer stream)
Dumps the content of the declaration into a string for human
consumption.
Parameters:
stream - is a stream opened and ready for writing. | | public void | toXML(Writer stream, String indent, String namespace)
Dump the state of the current element as XML output. |
| Declare | | public Declare()(Code) | | Default ctor: needed for JDO
|
| Declare | | public Declare(String name, int ct, int link) throws IllegalArgumentException(Code) | | ctor: Construct a new formal argument with a binding and default
container type, as well as a linkage for the argument.
Parameters:
name - is the binding.
Parameters:
ct - is the container type, the type of the argument.
Parameters:
link - is the linkage type for the argument.
throws:
IllegalArgumentException - if the container type is outsidethe legal range [Value.SCALAR, Value.LIST], orthe linkage is outside [LFN.NONE, LFN.INOUT]. |
| Declare | | public Declare(String name, Value value)(Code) | | ctor: Construct a new formal argument with a binding and default
value. The container type will be determined from the default value.
Parameters:
name - is the binding.
Parameters:
value - is either a Scalar or List value. |
| Declare | | public Declare(String name, Value value, int link) throws IllegalArgumentException(Code) | | ctor: Construct a new formal argument with a binding and default
value. The container type will be determined from the default value.
The linkage is set separately.
Parameters:
name - is the binding.
Parameters:
value - is either a Scalar or List value.
Parameters:
link - is the linkage of the value for DAG creation.
throws:
IllegalArgumentException - if the linkage is outside[LFN.NONE, LFN.INOUT]. |
| getContainerType | | public int getContainerType()(Code) | | Accessor: Obtains the container type. Note that the registered
container type will be taken in case there is no default value.
Otherwise the container type of the default value will be taken.
the container type of the formal argument.
See Also: Declare.setContainerType(int)
See Also: Value.SCALAR
See Also: Value.LIST |
| setName | | public void setName(String name)(Code) | | Accessor: Establishes a new name with this formal argument to bind
to by an actual argument. FIXME: Note that no checks will be done
concerning the uniqueness of the new name.
Parameters:
name - is the new binding.
See Also: Declare.getName() |
| setValue | | public void setValue(Value value) throws IllegalArgumentException(Code) | | Accessor: Sets or overwrites the optional default value of a formal
argument. FIXME: A value of null should be usable to kill a default
value. The new default must match the container type.
Parameters:
value - is the new default value.
throws:
IllegalArgumentException - if the container type of the newvalue and of the registered container type for the parameter don'tmatch.
See Also: Declare.getValue() |
| toString | | public String toString()(Code) | | Dumps the content of the use element into a string for human consumption.
a textual description of the element and its attributes.Be advised that these strings might become large. |
| toString | | public void toString(Writer stream) throws IOException(Code) | | Dumps the content of the declaration into a string for human
consumption.
Parameters:
stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output.
exception:
IOException - if something fishy happens to the stream. |
| toXML | | public void toXML(Writer stream, String indent, String namespace) throws IOException(Code) | | Dump the state of the current element as XML output. This function
traverses all sibling classes as necessary, and converts the data
into pretty-printed XML output. The stream interface should be able
to handle large output efficiently, if you use a buffered writer.
Parameters:
stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output.
Parameters:
indent - is a String of spaces used for prettyprinting. The initial amount of spaces should be an empty string.The parameter is used internally for the recursive traversal.If a null value is specified, no indentation norlinefeeds will be generated.
Parameters:
namespace - is the XML schema namespace prefix. If neitherempty nor null, each element will be prefixed with this prefix,and the root element will map the XML namespace.
exception:
IOException - if something fishy happens to the stream. |
|
|