Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> ws >> jaxme >> [ generator overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.ws.jaxme.generator
Interface Generator  

All Superinterfaces:

PropertySource

---

public interface Generator

extends PropertySource

The Generator is a frontend for working with the SchemaReaders, SourceWriters and whatever else.

Usage: Generates java source definitions from various inputs:

• generate(java.net.URL) 55
• generate(java.io.File) 55
• generate(org.xml.sax.InputSource) 55

The inputs are interpreted into schema definitions by the SchemaReader set by calling setSchemaReader(org.apache.ws.jaxme.generator.SchemaReader) 55 .

Other properties give fine grained control over various aspects of the file generation:

• setForcingOverwrite(boolean) 55
• setSettingReadOnly(boolean) 55
• setTargetDirectory(java.io.File) 55

and the processing of the schema:

• setValidating(boolean) 55
setEntityResolver(org.xml.sax.EntityResolver) 55 )

Implementation note: If you update this interface, you should consider updating the following files and classes as well:

• Main
• XJCTask
• docs/Reference.html

Version:

$Id: Generator.java,v 1.5 2004/03/04 22:29:22 rdonkin Exp $

---

Method Summary
org.apache.ws.jaxme.generator.sg.SchemaSG	generate(java.io.File pFile)            Generates java source from the given File.
org.apache.ws.jaxme.generator.sg.SchemaSG	generate(org.xml.sax.InputSource pSource)            Generates java source from the given URL.
org.apache.ws.jaxme.generator.sg.SchemaSG	generate(java.net.URL pURL)            Generates java source from the given URL.
org.xml.sax.EntityResolver	getEntityResolver()           Returns the org.xml.sax.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 org.xml.sax.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

setSchemaReader

public void setSchemaReader(SchemaReader pSchemaReader)

Sets the SchemaReader to use.

---

getSchemaReader

public SchemaReader getSchemaReader()

Returns the SchemaReader being used.

---

setTargetDirectory

public void setTargetDirectory(java.io.File pDirectory)

Sets the directory where to create files.

---

getTargetDirectory

public java.io.File getTargetDirectory()

Returns the directory where to create files.

---

setValidating

public void setValidating(boolean pValidating)

Sets whether the generator is using a validating XML schema parser. Defaults to false.

---

isValidating

public boolean isValidating()

Returns whether the generator is using a validating XML schema parser. Defaults to false.

---

isForcingOverwrite

public boolean isForcingOverwrite()

Returns whether the generator is forcing an overwrite of files.

---

setForcingOverwrite

public void setForcingOverwrite(boolean pIsForcingOverwrite)

Sets whether the generator is forcing an overwrite of files.

---

isSettingReadOnly

public boolean isSettingReadOnly()

Returns whether the generator will create files in read-only mode.

---

setSettingReadOnly

public void setSettingReadOnly(boolean pIsSettingReadOnly)

Sets whether the generator will create files in read-only mode.

---

generate

public org.apache.ws.jaxme.generator.sg.SchemaSG generate(java.io.File pFile)
                                                   throws java.lang.Exception

Generates java source from the given File.

---

generate

public org.apache.ws.jaxme.generator.sg.SchemaSG generate(java.net.URL pURL)
                                                   throws java.lang.Exception

Generates java source from the given URL.

---

generate

public org.apache.ws.jaxme.generator.sg.SchemaSG generate(org.xml.sax.InputSource pSource)
                                                   throws java.lang.Exception

Generates java source from the given URL.

---

getKey

public java.lang.String getKey()

Returns a key for getting and setting custom data.

---

setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver pEntityResolver)

Sets the org.xml.sax.EntityResolver being used to import external schemata.

---

getEntityResolver

public org.xml.sax.EntityResolver getEntityResolver()

Returns the org.xml.sax.EntityResolver being used to import external schemata.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> ws >> jaxme >> [ generator overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---