|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Generator is a frontend for working with the SchemaReaders, SourceWriters and whatever else.
Usage: Generates java source definitions from various inputs:
The inputs are interpreted into schema
definitions by the SchemaReader
set by calling
setSchemaReader(org.apache.ws.jaxme.generator.SchemaReader)
.
Other properties give fine grained control over various aspects of the file generation:
and the processing of the schema:
setValidating(boolean)
setEntityResolver(org.xml.sax.EntityResolver)
)
Implementation note: If you update this interface, you should consider updating the following files and classes as well:
Method Summary | |
SchemaSG |
generate(java.io.File pFile)
Generates java source from the given File .
|
SchemaSG |
generate(org.xml.sax.InputSource pSource)
Generates java source from the given URL .
|
SchemaSG |
generate(java.net.URL pURL)
Generates java source from the given URL .
|
org.xml.sax.EntityResolver |
getEntityResolver()
Returns the EntityResolver being used to import external
schemata. |
java.lang.String |
getKey()
Returns a key for getting and setting custom data. |
SchemaReader |
getSchemaReader()
Returns the SchemaReader being used. |
java.io.File |
getTargetDirectory()
Returns the directory where to create files. |
boolean |
isForcingOverwrite()
Returns whether the generator is forcing an overwrite of files. |
boolean |
isSettingReadOnly()
Returns whether the generator will create files in read-only mode. |
boolean |
isValidating()
Returns whether the generator is using a validating XML schema parser. |
void |
setEntityResolver(org.xml.sax.EntityResolver pEntityResolver)
Sets the EntityResolver being used to import external
schemata. |
void |
setForcingOverwrite(boolean pIsForcingOverwrite)
Sets whether the generator is forcing an overwrite of files. |
void |
setSchemaReader(SchemaReader pSchemaReader)
Sets the SchemaReader to use. |
void |
setSettingReadOnly(boolean pIsSettingReadOnly)
Sets whether the generator will create files in read-only mode. |
void |
setTargetDirectory(java.io.File pDirectory)
Sets the directory where to create files. |
void |
setValidating(boolean pValidating)
Sets whether the generator is using a validating XML schema parser. |
Methods inherited from interface org.apache.ws.jaxme.generator.PropertySource |
getProperty, getProperty, setProperty |
Method Detail |
public void setSchemaReader(SchemaReader pSchemaReader)
Sets the SchemaReader to use.
public SchemaReader getSchemaReader()
Returns the SchemaReader being used.
public void setTargetDirectory(java.io.File pDirectory)
Sets the directory where to create files.
public java.io.File getTargetDirectory()
Returns the directory where to create files.
public void setValidating(boolean pValidating)
Sets whether the generator is using a validating XML schema parser. Defaults to false.
public boolean isValidating()
Returns whether the generator is using a validating XML schema parser. Defaults to false.
public boolean isForcingOverwrite()
Returns whether the generator is forcing an overwrite of files.
public void setForcingOverwrite(boolean pIsForcingOverwrite)
Sets whether the generator is forcing an overwrite of files.
public boolean isSettingReadOnly()
Returns whether the generator will create files in read-only mode.
public void setSettingReadOnly(boolean pIsSettingReadOnly)
Sets whether the generator will create files in read-only mode.
public SchemaSG generate(java.io.File pFile) throws java.lang.Exception
Generates java source from the given File
.
pFile
- reads the schema (from which the source is to be generated)
from the given file.
SchemaSG
describing the source generated
java.lang.Exception
public SchemaSG generate(java.net.URL pURL) throws java.lang.Exception
Generates java source from the given URL
.
pURL
- reads the schema (from which the source is to be generated)
from the given URL.
SchemaSG
describing the source generated
java.lang.Exception
public SchemaSG generate(org.xml.sax.InputSource pSource) throws java.lang.Exception
Generates java source from the given URL
.
pSource
- reads the schema (from which the source is to be generated)
from the SAX Input Source. The System ID should be (if possible) set.
SchemaSG
describing the source generated
java.lang.Exception
public java.lang.String getKey()
Returns a key for getting and setting custom data.
public void setEntityResolver(org.xml.sax.EntityResolver pEntityResolver)
Sets the EntityResolver
being used to import external
schemata.
public org.xml.sax.EntityResolver getEntityResolver()
Returns the EntityResolver
being used to import external
schemata.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |