|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.castor.builder.SourceGenerator
A Java Source generation tool which uses XML Schema definitions to create an Object model.
Nested Class Summary | |
static class |
SourceGenerator.Property
Names of properties used in the configuration file. |
Field Summary | |
(package private) static java.lang.String |
appDesc
The application description |
(package private) static java.lang.String |
appName
The application name |
(package private) static java.lang.String |
appURI
The application URI |
(package private) static java.lang.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. |
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. |
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(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.util.Properties |
getDefault()
Returns the default configuration file. |
static java.lang.String |
getJavaPackage(java.lang.String nsURL)
Gets a Java package to an XML namespace URL |
static java.lang.String |
getProperty(java.lang.String name,
java.lang.String defValue)
Returns a property from the default configuration file. |
static java.lang.String |
getQualifiedClassName(java.lang.String nsURL,
java.lang.String className)
Gets the qualified class name given an XML namespace URL |
static java.lang.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 getDefault() to load the configuration the
first time. |
static void |
main(java.lang.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. |
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. |
void |
setDefaultProperties(java.util.Properties properties)
|
void |
setDescriptorCreation(boolean createDescriptors)
Sets whether or not to create ClassDescriptors for the generated classes. |
void |
setDestDir(java.lang.String destDir)
|
static void |
setEqualsMethod(boolean equals)
Sets the 'equalsmethod' property |
void |
setLineSeparator(java.lang.String lineSeparator)
Sets the line separator to use when printing the source code |
static void |
setPrimitiveWrapper(boolean wrapper)
Sets the 'primitivetowrapper' property |
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. |
static boolean |
usePrimitiveWrapper()
Returns true if primitive types have to be used as Objects (eg. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
static final java.lang.String appName
static final java.lang.String appDesc
static final java.lang.String version
static final java.lang.String appURI
Constructor Detail |
public SourceGenerator()
public SourceGenerator(FieldInfoFactory infoFactory)
infoFactory
- the FieldInfoFactory to use.Method Detail |
public void generateSource(Schema schema, java.lang.String packageName)
schema
- the XML schema to generate the Java sources forpackageName
- the package for the generated source filespublic void generateSource(org.xml.sax.InputSource source, java.lang.String packageName)
packageName
- the package for the generated source filespublic void generateSource(java.io.Reader reader, java.lang.String packageName)
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 filespublic void generateSource(java.lang.String filename, java.lang.String packageName) throws java.io.FileNotFoundException
filename
- the full path to the XML Schema definitionpackageName
- the package for the generated source files
java.io.FileNotFoundException
public static java.lang.String getVersion()
public void setSuppressNonFatalWarnings(boolean suppress)
public void setVerbose(boolean verbose)
verbose
- a boolean, when true indicates to
print additional messagespublic void setDescriptorCreation(boolean createDescriptors)
createDescriptors
- a boolean, when true indicates
to generated ClassDescriptorspublic void setCreateMarshalMethods(boolean createMarshalMethods)
createMarshalMethods
- a boolean, when true indicates
to generated the marshalling framework methodspublic void setTestable(boolean testable)
public void setDefaultProperties(java.util.Properties properties)
public static void main(java.lang.String[] args)
args
- the String[] consisting of the command line argumentspublic void setDestDir(java.lang.String destDir)
public void setLineSeparator(java.lang.String lineSeparator)
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.
windows systems use: "\r\n" unix systems use: "\n" mac systems use: "\r"
public static java.util.Properties getDefault()
public static java.lang.String getProperty(java.lang.String name, java.lang.String defValue)
getDefault()
.
name
- The property name
public static boolean boundPropertiesEnabled()
public static boolean equalsMethod()
public static void setEqualsMethod(boolean equals)
public static boolean classDescFieldNames()
public static void setClassDescFieldNames(boolean classDescFieldNames)
public static boolean usePrimitiveWrapper()
public static void setPrimitiveWrapper(boolean wrapper)
public static boolean mappingSchemaElement2Java()
public static boolean mappingSchemaType2Java()
public static java.lang.String getJavaPackage(java.lang.String nsURL)
public static java.lang.String getQualifiedClassName(java.lang.String nsURL, java.lang.String className)
protected static void load()
getDefault()
to load the configuration the
first time. Will not complain about inability to load
configuration file from one of the default directories, but if
it cannot find the JAR's configuration file, will throw a
run time exception.
protected static void initBindingType()
public static java.lang.String toURIRepresentation(java.lang.String path)
Returns a string which is the URI of a file.
path
- the absolute path of the file.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |