org.castor.ddlgen
Class DDLWriter
Writer
org.castor.ddlgen.DDLWriter
public final class DDLWriter
extends Writer
Replace PrintStream and StringBuffer by a Writer implementation
We have various properties to configure output that are in-depended of the schema object:
org.castor.ddlgen.CharFormat=SENSITIVE, UPPER and LOWER
org.castor.ddlgen.Newline=\n
org.castor.ddlgen.Indention=\t
These properties are accessed at various places all around ddlgen at the moment.The idea
is that these properties are set only once at the new Writer and do not need to be
accessed elsewhere. This has the following advantages:
improved performance as the properties don't need to be accessed for every object to output
functionallity to format genertaed ddl is concentrated in one class: the new Writer
all the toDDL(), toDropDDL(), toCreateDDL() methods get much shorter
I thought of the following interface for the new Writer (not complete):
write(String) outputs String as is
writeln(String) calls write(String) followed by newline()
newline() output newline and indention of next line
indent() increases indention
unindent() decreases indention
More write() and writeln() methods for other data types may be added on demand. A further
improvement could be to offer write(String, Object[]) methods that internally use
MessageFormat. This would enable us to use a pattern based approach for DDL generation.
These patterns may sometimes be much easier to read and maintain.
In addition to the introduction of the new Writer it will be required to pass an instance
of the Writer to every method where DDL gets generated. Therefore the parameterless
toCreate() method have to be changed to toCreateDDL(DDLWriter). This also applies to other
such methods.
$Revision: 5951 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $DDLWriter(OutputStream output, Configuration conf) - Construct new DDLWriter with given output stream and configuration file.
|
DDLWriter(Writer writer, Configuration conf) - Construct new DDLWriter with given writer and configuration file.
|
void | checkError() - Check if any error occured at previous operations of the writer.
|
void | close() - Close the writer.
|
void | flush() - Flush the writer.
|
void | indent() - Increase indention by 1.
|
void | print(Object object) - Print an object.
|
void | print(String string) - Print a string.
|
void | print(String pattern, Object[] arguments) - A convenience method to print a formatted string build by filling placeholders of the
specified pattern with given arguments.
|
void | print(char[] chars) - Print an array of characters.
|
void | print(double number) - Print a double-precision floating-point number.
|
void | print(int number) - Print an integer number.
|
void | print(long number) - Print a long number.
|
void | println() - Terminate the current line by writing the line separator string.
|
void | println(Object object) - Print an object and terminate the line.
|
void | println(String string) - Print a string and terminate the line.
|
void | println(String pattern, Object[] arguments) - A convenience method to print a formatted string build by filling placeholders of the
specified pattern with given arguments.
|
void | println(char[] chars) - Print an array of characters and terminate the line.
|
void | println(double number) - Print a double-precision floating-point number and terminate the line.
|
void | println(int number) - Print an integer number and terminate the line.
|
void | println(long number) - Print a long number and terminate the line.
|
void | unindent() - Decrease indention by 1.
|
void | write(String s) -
|
void | write(String s, int off, int len) -
|
void | write(char[] buf) -
|
void | write(char[] buf, int off, int len) -
|
void | write(int c) -
|
DDLWriter
public DDLWriter(OutputStream output,
Configuration conf)
Construct new DDLWriter with given output stream and configuration file.
output
- Output stream to write output characters to.conf
- Configuration.
DDLWriter
public DDLWriter(Writer writer,
Configuration conf)
Construct new DDLWriter with given writer and configuration file.
writer
- Writer to write output characters to.conf
- Configuration.
checkError
public void checkError()
throws IOException
Check if any error occured at previous operations of the writer. If an IOException was
caught at any previous operation of the writer it will be thrown now.
close
public void close()
Close the writer.
flush
public void flush()
Flush the writer.
indent
public void indent()
Increase indention by 1.
print
public void print(Object object)
Print an object.
object
- Object to be printed.
print
public void print(String string)
Print a string.
string
- String to be printed.
print
public void print(String pattern,
Object[] arguments)
A convenience method to print a formatted string build by filling placeholders of the
specified pattern with given arguments.
pattern
- Pattern with placeholders.arguments
- Arguments to replace placeholders in pattern.
print
public void print(char[] chars)
Print an array of characters.
chars
- Array of chars to be printed.
print
public void print(double number)
Print a double-precision floating-point number.
number
- Double to be printed.
print
public void print(int number)
Print an integer number.
number
- Integer to be printed.
print
public void print(long number)
Print a long number.
number
- Long to be printed.
println
public void println()
Terminate the current line by writing the line separator string.
println
public void println(Object object)
Print an object and terminate the line.
object
- Object to be printed.
println
public void println(String string)
Print a string and terminate the line.
string
- String to be printed.
println
public void println(String pattern,
Object[] arguments)
A convenience method to print a formatted string build by filling placeholders of the
specified pattern with given arguments. Line will be terminated after the formatted string.
pattern
- Pattern with placeholders.arguments
- Arguments to replace placeholders in pattern.
println
public void println(char[] chars)
Print an array of characters and terminate the line.
chars
- Array of chars to be printed.
println
public void println(double number)
Print a double-precision floating-point number and terminate the line.
number
- Double to be printed.
println
public void println(int number)
Print an integer number and terminate the line.
number
- Integer to be printed.
println
public void println(long number)
Print a long number and terminate the line.
number
- Long to be printed.
unindent
public void unindent()
Decrease indention by 1.
write
public void write(String s)
write
public void write(String s,
int off,
int len)
write
public void write(char[] buf)
write
public void write(char[] buf,
int off,
int len)
write
public void write(int c)
Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com