org.exolab.castor.builder
public class SourceGenerator extends Object
Version: $Revision: 1.6 $ $Date: 2003/06/02 13:24:10 $
Nested Class Summary | |
---|---|
static class | SourceGenerator.Property
Names of properties used in the configuration file. |
Field Summary | |
---|---|
static String | APP_DESC
The application description
|
static String | APP_NAME
The application name
|
static String | APP_URI
The application URI
|
static String | VERSION
The application version
|
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, ExtendedBinding binding)
Creates a SourceGenerator using the specific field info Factory and the
given Binding element .
|
Method Summary | |
---|---|
static boolean | boundPropertiesEnabled()
Returns true if bound properties are enabled.
|
static boolean | classDescFieldNames()
Returns true if we generate a 'public static final String' for the
name of each attribute and element described by the class descriptor
Enabling this property is controlled via
the org.exolab.castor.builder.classdescfieldnames item
in the castorbuilder.properties file. |
static boolean | equalsMethod()
Returns true if we generate an 'equals' method for
each generated class.
|
static boolean | generateExtraCollectionMethods()
Returns true if extra methods for collection fields should
be generated. |
void | generateSource(Schema schema, String packageName)
Creates Java Source code (Object model) for the given XML Schema.
|
void | generateSource(InputSource source, String packageName)
Creates Java Source code (Object model) for the given XML Schema
|
void | generateSource(Reader reader, String packageName)
Creates Java Source code (Object model) for the given XML Schema.
|
void | generateSource(String filename, String packageName)
Creates Java Source code (Object model) for the given XML Schema.
|
static Properties | getDefault()
Returns the default configuration file. |
static String | getProperty(String name, String defValue)
Returns a property from the default configuration file.
|
static String | getVersion()
Returns the version number of this SourceGenerator
|
protected static void | initBindingType()
Called by #load to initialize the binding type
|
protected static void | load()
Called by {@link #getDefault} to load the configuration the
first time. |
static String | lookupPackageLocation(String schemaLocation)
Gets a Java package to a schema location. |
static String | lookupPackageNamespace(String nsURL)
Gets a Java package to an XML namespace URL |
static void | main(String[] args)
main class used for command line invocation |
static boolean | mappingSchemaElement2Java()
Tests the org.exolab.castor.builder.javaclassmapping property for the 'element' value.
|
static boolean | mappingSchemaType2Java()
Tests the org.exolab.castor.builder.javaclassmapping property for the 'type' value.
|
protected static void | processNamespacePackageMappings(String mappings) |
void | setBinding(ExtendedBinding binding)
Sets the binding to use with this instance of the SourceGenerator.
|
void | setBinding(String fileName)
Sets the binding to use given the path name of a Castor Binding File.
|
void | setBinding(InputSource source)
Sets the binding to use given an InputSource identifying
a Castor Binding File.
|
static void | setClassDescFieldNames(boolean classDescFieldNames)
Sets the 'classDescFieldNames' property |
void | setCreateMarshalMethods(boolean createMarshalMethods)
Sets whether or not to create the XML marshalling framework specific
methods (marshall, unmarshall, validate) in the generated classes.
|
static void | setDefaultProperties(Properties properties)
Override the properties |
void | setDescriptorCreation(boolean createDescriptors)
Sets whether or not to create ClassDescriptors for
the generated classes. |
void | setDestDir(String destDir)
Sets the destination directory.
|
static void | setEqualsMethod(boolean equals)
Sets the 'equalsmethod' property |
void | setLineSeparator(String lineSeparator)
Sets the line separator to use when printing the source code |
static void | setPrimitiveWrapper(boolean wrapper)
Sets the 'primitivetowrapper' property |
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 String | toURIRepresentation(String path) Returns a string which is the URI of a file. |
static boolean | usePrimitiveWrapper()
Returns true if primitive types have to be used
as Objects (eg. replacing float by java.lang.Float). |
Parameters: infoFactory the FieldInfoFactory to use.
Parameters: infoFactory the FieldInfoFactory to use. binding the binding element to use.
Returns: true if bound properties are enabled.
Returns: true if bound properties are enabled.
Returns: true if bound properties are enabled.
Returns: true if extra collection methods are enabled.
Parameters: schema the XML schema to generate the Java sources for. packageName the package for the generated source files.
Parameters: InputSource - the InputSource representing the XML schema. packageName the package for the generated source files
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
Parameters: filename the full path to the XML Schema definition packageName the package for the generated source files
Returns: The default configuration
Parameters: name The property name default The property's default value
Returns: The property's value
Returns: the version number of this SourceGenerator
Parameters: args the String[] consisting of the command line arguments
Returns: True if the Source Generator is mapping schema elements to Java classes.
Returns: True if the Source Generator is mapping schema types to Java classes.
Parameters: binding the binding to use, null indicates that the default binding will be used.
Parameters: fileName the file that represents a Binding
Parameters: source an InputSource identifying a Castor Binding File.
Parameters: boolean the value we want to ues
Parameters: createMarshalMethods a boolean, when true indicates to generated the marshalling framework methods
Parameters: createDescriptors a boolean, when true indicates to generated ClassDescriptors
Parameters: destDir the destination directory.
Parameters: boolean the value we want to use
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"
Parameters: boolean the value we want to use.
Parameters: createMarshall a boolean, when true indicates to generated the marshalling framework methods
Parameters: verbose a boolean, when true indicates to print additional messages
Returns a string which is the URI of a file.
Parameters: path the absolute path of the file.
UNKNOWN: a string representing the URI of the file