| java.lang.Object
 java.io.Writer
java.io.FilterWriter
org.geotools.parameter.ParameterWriter
All known Subclasses: org.geotools.coverage.processing.CoverageParameterWriter,
| ParameterWriter | | public class ParameterWriter extends FilterWriter (Code) | | Format
or
in a tabular format.
This writer assumes a monospaced font and an encoding capable to provide
drawing box characters (e.g. unicode).
since:
2.1
version:
$Id: ParameterWriter.java 23632 2006-12-29 22:13:51Z desruisseaux $
author:
Martin Desruisseaux |
| Constructor Summary | |
| public | ParameterWriter()
Creates a new formatter writting parameters to the
. | | public | ParameterWriter(Writer out)
Creates a new formatter writting parameters to the specified output stream. |
| Method Summary | |
| public void | format(OperationMethod operation)
Prints the elements of an operation to the output stream. | | public void | format(ParameterDescriptorGroup descriptor)
Prints the elements of a descriptor group to the output stream. | | public void | format(ParameterValueGroup values)
Prints the elements of a parameter group to the output stream. | | protected String | formatValue(Object value)
Format the specified value as a string. | | public Locale | getLocale()
Returns the current locale. | | public static void | print(OperationMethod operation)
Prints the elements of an operation to the
. | | public static void | print(ParameterDescriptorGroup descriptor)
Prints the elements of a descriptor group to the
. | | public static void | print(ParameterValueGroup values)
Prints the elements of a parameter group to the
. | | public void | setLocale(Locale locale)
Set the locale to use for table formatting. | | public void | summary(Collection parameters, Set scopes)
Format a summary of a collection of
.
The summary contains the identifier name and alias aligned in a table.
Parameters:
parameters - The collection of parameters to format.
Parameters:
scopes - The set of scopes to include in the table, of null for allof them. |
| ParameterWriter | | public ParameterWriter()(Code) | | Creates a new formatter writting parameters to the
.
|
| ParameterWriter | | public ParameterWriter(Writer out)(Code) | | Creates a new formatter writting parameters to the specified output stream.
|
| format | | public void format(OperationMethod operation) throws IOException(Code) | | Prints the elements of an operation to the output stream.
Parameters:
operation - The operation method to format.
throws:
IOException - if an error occured will writing to the stream. |
| format | | public void format(ParameterDescriptorGroup descriptor) throws IOException(Code) | | Prints the elements of a descriptor group to the output stream.
Parameters:
descriptor - The descriptor group to format.
throws:
IOException - if an error occured will writing to the stream. |
| format | | public void format(ParameterValueGroup values) throws IOException(Code) | | Prints the elements of a parameter group to the output stream.
Parameters:
values - The parameter group to format.
throws:
IOException - if an error occured will writing to the stream. |
| formatValue | | protected String formatValue(Object value)(Code) | | Format the specified value as a string. This method is automatically invoked
by
format(...) methods. The default implementation format
Number ,
Date and
Angle object according the
. This method can been overridden if
more objects need to be formatted in a special way.
Parameters:
value - the value to format. The value formatted as a string. |
| getLocale | | public Locale getLocale()(Code) | | Returns the current locale. Newly constructed
ParameterWriter use the
.
|
| print | | public static void print(OperationMethod operation)(Code) | | Prints the elements of an operation to the
.
This is a convenience method for new
ParameterWriter().
(operation).
|
| print | | public static void print(ParameterDescriptorGroup descriptor)(Code) | | Prints the elements of a descriptor group to the
.
This is a convenience method for new
ParameterWriter().
(descriptor).
|
| print | | public static void print(ParameterValueGroup values)(Code) | | Prints the elements of a parameter group to the
.
This is a convenience method for new
ParameterWriter().
(values).
|
| setLocale | | public void setLocale(Locale locale)(Code) | | Set the locale to use for table formatting.
|
| summary | | public void summary(Collection parameters, Set scopes) throws IOException(Code) | | Format a summary of a collection of
.
The summary contains the identifier name and alias aligned in a table.
Parameters:
parameters - The collection of parameters to format.
Parameters:
scopes - The set of scopes to include in the table, of null for allof them. A restricted a set will produce a table with less columns.
throws:
IOException - if an error occured will writing to the stream. |
|
|