| org.griphyn.vdl.classes.VDL
 org.griphyn.vdl.classes.Leaf
org.griphyn.vdl.classes.Use
| Use | | public class Use extends Leaf implements Cloneable,Serializable(Code) | | Use is employed to reference bound actual arguments. Note
that actual arguments are either of type Scalar or
of type List. Each argument has a preferred linkage that
is optionally repeated in this usage class.
Use extends the base class Leaf by adding
most attributes of all siblings.
author:
Jens-S. Vöckler
author:
Yong Zhao
version:
$Revision: 50 $
See Also: Leaf
See Also: Text
See Also: LFN
See Also: Value
See Also: Scalar
See Also: List |
| Method Summary | |
| public Object | clone()
Creates and returns a copy of this object. | | public int | getLink()
Accessor: Obtains the current state of the linkage.
the linkage value. | | public String | getName()
Accessor: Obtains the name of the bound actual argument.
the bound name. | | public String | getPrefix()
Accessor: Obtains the current prefix rendering information. | | public String | getSeparator()
Accessor: Obtains the current separator rendering information. | | public String | getSuffix()
Accessor: Obtains the current suffix rendering information. | | public void | setLink(int link)
Accessor: Sets the linkage of the bound argument. | | public void | setName(String name)
Accessor: Sets or overwrites the name of the bound argument. | | public void | setPrefix(String prefix)
Accessor: Sets or overwrites the current prefix rendering information.
The prefix is used in
List rendering as front bracket. | | public void | setSeparator(String separator)
Accessor: Sets or overwrites the current separator rendering information.
The separator is used between
List element during rendering. | | public void | setSuffix(String suffix)
Accessor: Sets or overwrites the current suffix rendering information.
The suffix is used in
List rendering as rear bracket. | | public void | toString(Writer stream)
Dump content of this instance representation into a stream.
FIXME: The rendering information is not dumped into the non-XML output.
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. |
| Use | | public Use()(Code) | | Default ctor. Creates an empty object that is not valid due
to the lack of a bound variable name. To be used by the SAX
parser.
|
| Use | | public Use(String name)(Code) | | Convenience ctor. Creates an empty object with a bound argument
name. This ctor should be used by outside applications to assure
proper initialization of the bound argument name.
Parameters:
name - is the name of the bound argument to remember. |
| Use | | public Use(String name, String prefix, String separator, String suffix)(Code) | | Convenience ctor. Creates an object with a bound argument name.
This ctor should be used by outside applications to assure proper
initialization of the bound argument name.
Parameters:
name - is the name of the bound argument to remember.
Parameters:
prefix - is a prefix when rendering list content into a string.
Parameters:
separator - is a string to be placed between list elements whenrendering a list.
Parameters:
suffix - is a suffix when rendering list content into a string.
See Also: Scalar
See Also: List |
| Use | | public Use(String name, int link) throws IllegalArgumentException(Code) | | Convenience ctor. Creates an object with a bound argument name.
This ctor should be used by outside applications to assure proper
initialization of the bound argument name.
Parameters:
name - is the name of the bound argument to remember.
Parameters:
link - is the linkage type of the bound argument for type checking.
throws:
IllegalArgumentException - if the linkage is notwithin the legal range between LFN.NONE andLFN.INOUT. |
| clone | | public Object clone()(Code) | | Creates and returns a copy of this object.
a new instance. |
| getLink | | public int getLink()(Code) | | Accessor: Obtains the current state of the linkage.
the linkage value. The returned value might be -1 to indicatethat the linkage was not initialized. Note that -1 is an out of rangevalue for linkage.
See Also: Use.setLink(int) |
| getName | | public String getName()(Code) | | Accessor: Obtains the name of the bound actual argument.
the bound name. A misconfigured object might return an emptyor null string.
See Also: Use.setName(String) |
| getPrefix | | public String getPrefix()(Code) | | Accessor: Obtains the current prefix rendering information. The
prefix is used in
List rendering as front bracket.
the prefix rendering string, which might be null or empty.
See Also: Use.setPrefix(String) |
| getSeparator | | public String getSeparator()(Code) | | Accessor: Obtains the current separator rendering information. The
separator is used in
List rendering as element separator.
the separator rendering string, which might be null or empty.
See Also: Use.setSeparator(String) |
| getSuffix | | public String getSuffix()(Code) | | Accessor: Obtains the current suffix rendering information. The
suffix is used in
List rendering as rear bracket.
the suffix rendering string, which might be null or empty.
See Also: Use.setSuffix(String) |
| setName | | public void setName(String name)(Code) | | Accessor: Sets or overwrites the name of the bound argument.
Do not use empty or null strings here.
Parameters:
name - is the new variable name to remember.
See Also: Use.getName() |
| setPrefix | | public void setPrefix(String prefix)(Code) | | Accessor: Sets or overwrites the current prefix rendering information.
The prefix is used in
List rendering as front bracket.
Parameters:
prefix - is a rendering string, which might be null or empty.
See Also: Use.getPrefix() |
| setSeparator | | public void setSeparator(String separator)(Code) | | Accessor: Sets or overwrites the current separator rendering information.
The separator is used between
List element during rendering.
Parameters:
separator - is a rendering string, which might be null or empty.
See Also: Use.getSeparator() |
| setSuffix | | public void setSuffix(String suffix)(Code) | | Accessor: Sets or overwrites the current suffix rendering information.
The suffix is used in
List rendering as rear bracket.
Parameters:
suffix - is a rendering string, which might be null or empty.
See Also: Use.getSuffix() |
| toString | | public void toString(Writer stream) throws IOException(Code) | | Dump content of this instance representation into a stream.
FIXME: The rendering information is not dumped into the non-XML output.
Parameters:
stream - is a stream opened and ready for writing. This canalso be a string stream for efficient output. The stream interfaceshould be able to handle large elements efficiently.
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. |
|
|