org.exolab.castor.builder
Class SourceGenerator

java.lang.Object
  org.exolab.castor.builder.BuilderConfiguration
      org.exolab.castor.builder.SourceGenerator

public class SourceGenerator

extends BuilderConfiguration

A Java Source generation tool which uses XML Schema definitions to create an Object model.

Version:

$Revision: 1.12 $ $Date: 2004/02/21 10:26:29 $

Author:

Keith Visco - Main author., Arnaud Blandin - Contributions., Nathan Green - Contributions.

Nested Class Summary

Nested classes inherited from class org.exolab.castor.builder.BuilderConfiguration

BuilderConfiguration.Property

Constructor Summary

SourceGenerator()
Creates a SourceGenerator using the default FieldInfo factory

SourceGenerator(FieldInfoFactory infoFactory)
Creates a SourceGenerator using the specific field info Factory.

SourceGenerator(FieldInfoFactory infoFactory, org.exolab.castor.builder.binding.ExtendedBinding binding)
Creates a SourceGenerator using the specific field info Factory and the given Binding element .

Method Summary

void	generateSource(org.xml.sax.InputSource source, java.lang.String packageName) Creates Java Source code (Object model) for the given XML Schema
void	generateSource(java.io.Reader reader, java.lang.String packageName) Creates Java Source code (Object model) for the given XML Schema.
void	generateSource(org.exolab.castor.xml.schema.Schema schema, java.lang.String packageName) Creates Java Source code (Object model) for the given XML Schema.
void	generateSource(java.lang.String filename, java.lang.String packageName) Creates Java Source code (Object model) for the given XML Schema.
static java.lang.String	getVersion() Returns the version number of this SourceGenerator
static void	main(java.lang.String[] args) main class used for command line invocation
boolean	mappingSchemaElement2Java() Tests the org.exolab.castor.builder.javaclassmapping property for the 'element' value.
boolean	mappingSchemaType2Java() Tests the org.exolab.castor.builder.javaclassmapping property for the 'type' value.
void	setBinding(org.exolab.castor.builder.binding.ExtendedBinding binding) Sets the binding to use with this instance of the SourceGenerator.
void	setBinding(org.xml.sax.InputSource source) Sets the binding to use given an InputSource identifying a Castor Binding File.
void	setBinding(java.lang.String fileName) Sets the binding to use given the path name of a Castor Binding File.
void	setCreateMarshalMethods(boolean createMarshalMethods) Sets whether or not to create the XML marshalling framework specific methods (marshall, unmarshall, validate) in the generated classes.
void	setDescriptorCreation(boolean createDescriptors) Sets whether or not to create ClassDescriptors for the generated classes.
void	setDestDir(java.lang.String destDir) Sets the destination directory.
void	setGenerateImportedSchemas(boolean generate) Sets whether or not to generate Java sources for imported XML Schema.
void	setLineSeparator(java.lang.String lineSeparator) Sets the line separator to use when printing the source code
void	setSAX1(boolean sax1) Set to true if SAX1 should be used in the marshall method
void	setSuppressNonFatalWarnings(boolean suppress)
void	setTestable(boolean testable) Sets whether or not to create the XML marshalling framework specific methods (marshall, unmarshall, validate) in the generated classes.
void	setVerbose(boolean verbose) Sets whether or not the source code generator prints additional messages during generating source code
static java.lang.String	toURIRepresentation(java.lang.String path) Returns a string which is the URI of a file.

Methods inherited from class org.exolab.castor.builder.BuilderConfiguration

boundPropertiesEnabled, classDescFieldNames, equalsMethod, generateExtraCollectionMethods, getDefault, getProperty, lookupPackageByLocation, lookupPackageByNamespace, setClassDescFieldNames, setDefaultProperties, setEqualsMethod, setLocationPackageMapping, setNamespacePackageMapping, setPrimitiveWrapper, usePrimitiveWrapper

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SourceGenerator

public SourceGenerator()

Creates a SourceGenerator using the default FieldInfo factory

SourceGenerator

public SourceGenerator(FieldInfoFactory infoFactory)

Creates a SourceGenerator using the specific field info Factory.

Parameters:

infoFactory - the FieldInfoFactory to use.

SourceGenerator

public SourceGenerator(FieldInfoFactory infoFactory,
                       org.exolab.castor.builder.binding.ExtendedBinding binding)

Creates a SourceGenerator using the specific field info Factory and the given Binding element .

Parameters:

infoFactory - the FieldInfoFactory to use.

binding - the binding element to use.

Method Detail

generateSource

public void generateSource(org.exolab.castor.xml.schema.Schema schema,
                           java.lang.String packageName)

Creates Java Source code (Object model) for the given XML Schema.

Parameters:

schema - the XML schema to generate the Java sources for.

packageName - the package for the generated source files.

generateSource

public void generateSource(org.xml.sax.InputSource source,
                           java.lang.String packageName)

Creates Java Source code (Object model) for the given XML Schema

Parameters:

packageName - the package for the generated source files

generateSource

public void generateSource(java.io.Reader reader,
                           java.lang.String packageName)

Creates Java Source code (Object model) for the given XML Schema.

Parameters:

reader - the Reader with which to read the XML Schema definition. The caller should close the reader, since thie method will not do so.

packageName - the package for the generated source files

generateSource

public void generateSource(java.lang.String filename,
                           java.lang.String packageName)
                    throws java.io.FileNotFoundException

Creates Java Source code (Object model) for the given XML Schema.

Parameters:

filename - the full path to the XML Schema definition

packageName - the package for the generated source files

Throws:

java.io.FileNotFoundException

getVersion

public static java.lang.String getVersion()

Returns the version number of this SourceGenerator

Returns:

the version number of this SourceGenerator

setSAX1

public void setSAX1(boolean sax1)

Set to true if SAX1 should be used in the marshall method

setSuppressNonFatalWarnings

public void setSuppressNonFatalWarnings(boolean suppress)

setVerbose

public void setVerbose(boolean verbose)

Sets whether or not the source code generator prints additional messages during generating source code

Parameters:

verbose - a boolean, when true indicates to print additional messages

setDescriptorCreation

public void setDescriptorCreation(boolean createDescriptors)

Sets whether or not to create ClassDescriptors for the generated classes. By default, descriptors are generated.

Parameters:

createDescriptors - a boolean, when true indicates to generated ClassDescriptors

setDestDir

public void setDestDir(java.lang.String destDir)

Sets the destination directory.

Parameters:

destDir - the destination directory.

setCreateMarshalMethods

public void setCreateMarshalMethods(boolean createMarshalMethods)

Sets whether or not to create the XML marshalling framework specific methods (marshall, unmarshall, validate) in the generated classes. By default, these methods are generated.

Parameters:

createMarshalMethods - a boolean, when true indicates to generated the marshalling framework methods

setGenerateImportedSchemas

public void setGenerateImportedSchemas(boolean generate)

Sets whether or not to generate Java sources for imported XML Schema. By default Java sources for imported XML schemas are not generated.

Parameters:

generate - true to generate the java classes for the imported XML Schema

setTestable

public void setTestable(boolean testable)

Sets whether or not to create the XML marshalling framework specific methods (marshall, unmarshall, validate) in the generated classes. By default, these methods are generated.

setBinding

public void setBinding(org.exolab.castor.builder.binding.ExtendedBinding binding)

Sets the binding to use with this instance of the SourceGenerator.

Parameters:

binding - the binding to use, null indicates that the default binding will be used.

setBinding

public void setBinding(java.lang.String fileName)

Sets the binding to use given the path name of a Castor Binding File.

Parameters:

fileName - the file that represents a Binding

setBinding

public void setBinding(org.xml.sax.InputSource source)

Sets the binding to use given an InputSource identifying a Castor Binding File.

Parameters:

source - an InputSource identifying a Castor Binding File.

main

public static void main(java.lang.String[] args)

main class used for command line invocation

Parameters:

args - the String[] consisting of the command line arguments

setLineSeparator

public void setLineSeparator(java.lang.String lineSeparator)

Sets the line separator to use when printing the source code

Parameters:

lineSeparator - the line separator to use when printing the source code. This method is useful if you are generating source on one platform, but will be compiling the source on a different platform.
Note:This can be any string, so be careful. I recommend either using the default or using one of the following:

   windows systems use: "\r\n"
   unix systems use: "\n"
   mac systems use: "\r"
 

mappingSchemaElement2Java

public boolean mappingSchemaElement2Java()

Tests the org.exolab.castor.builder.javaclassmapping property for the 'element' value.

Overrides:

mappingSchemaElement2Java in class BuilderConfiguration

Returns:

True if the Source Generator is mapping schema elements to Java classes.

mappingSchemaType2Java

public boolean mappingSchemaType2Java()

Tests the org.exolab.castor.builder.javaclassmapping property for the 'type' value.

Overrides:

mappingSchemaType2Java in class BuilderConfiguration

Returns:

True if the Source Generator is mapping schema types to Java classes.

toURIRepresentation

public static java.lang.String toURIRepresentation(java.lang.String path)

Returns a string which is the URI of a file.

• file:///DOSpath
• file://UnixPath

No validation is done to check wether the file exists or not. This method will be no longer used when the JDK URL.toString() is fixed.

Parameters:

path - the absolute path of the file.