SGStateInfo (Castor XML - Code generator 1.4.1 API)

java.lang.Object
- org.exolab.castor.builder.util.ClassInfoResolverImpl
- - org.exolab.castor.builder.SGStateInfo

All Implemented Interfaces:

ClassInfoResolver
```
public final class SGStateInfo
extends ClassInfoResolverImpl
```
A class for maintaining state for the SourceGenerator.

Version:

$Revision$ $Date: 2005-06-22 22:13:21 -0600 (Wed, 22 Jun 2005) $

Author:

Keith Visco

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`NORMAL_STATUS` The SourceGenerator is still generating source.
`static int`	`STOP_STATUS` The SourceGenerator has been stopped by an error or by the user.

Constructor Summary

Constructors
Modifier Constructor and Description

protected SGStateInfo(Schema schema, SourceGenerator sgen)
Creates a new SGStateInfo.

Constructors
Modifier	Constructor and Description
`protected`	`SGStateInfo(Schema schema, SourceGenerator sgen)` Creates a new SGStateInfo.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bindSourceCode(Annotated annotated, JClass[] classes)` Binds the given Annotated structure with its generated source classes.
`Properties`	`getCDRFile(String filename)` Returns the CDRFile (Properties file) associated with the given filename.
`Enumeration<String>`	`getCDRFilenames()` Returns the set of CDR file names.
`FactoryState`	`getCurrentFactoryState()` Returns the current FactoryState that holds information about the classes being generated.
`Dialog`	`getDialog()` Returns the Dialog used for interacting with the user.
`JClass`	`getImportedSourceCode(String className)` Returns the JClass with the given name or null if no bindings have been specified for a JClass with the name.
`Map<String,JClass>`	`getImportedSourcesByName()` Returns the sources as generated through XML schema imports.
`MappingRoot`	`getMapping(String filename)` Returns the Mapping file associated with the given filename.
`Enumeration<String>`	`getMappingFilenames()` Returns the set of mapping filenames.
`String`	`getPackageName()` Get package used when creating new classes.
`JClass[]`	`getSourceCode(Annotated annotated)` Returns the array of JClass for the given Annotated structure or null if no bindings have been specified for the given Structure.
`JClass`	`getSourceCode(String className)` Returns the JClass with the given name or null if no bindings have been specified for a JClass with the name.
`SourceGenerator`	`getSourceGenerator()` Returns the SourceGenerator instance being used.
`Map<String,JClass>`	`getSourcesByName()` Returns the sources as generated through XML schema imports.
`int`	`getStatusCode()` Returns the current status.
`boolean`	`getSuppressNonFatalWarnings()` Returns true if non-fatal warnings should be suppressed.
`void`	`setCDRFile(String filename, Properties props)` Sets the CDR (ClassDescriptorResolver) file associated with the given filename.
`void`	`setCurrentFactoryState(FactoryState state)` Sets the current FactoryState.
`void`	`setMapping(String filename, MappingRoot mapping)` Sets the Mapping file associated with the given filename.
`protected void`	`setPackageName(String packageName)` Set package used when creating new classes.
`void`	`setStatusCode(int status)` Sets the current status code to the given one.
`void`	`storeImportedSourcesByName(Map<String,JClass> importedSourcesByName)` Stores generated sources as processed within an imported schema.
`boolean`	`verbose()` Returns the value of the verbose flag.

Methods inherited from class org.exolab.castor.builder.util.ClassInfoResolverImpl
bindReference, keys, resolve

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NORMAL_STATUS
```
public static final int NORMAL_STATUS
```
    The SourceGenerator is still generating source.
    
    See Also:
    
    Constant Field Values
  - STOP_STATUS
```
public static final int STOP_STATUS
```
    The SourceGenerator has been stopped by an error or by the user.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SGStateInfo
```
protected SGStateInfo(Schema schema,
                      SourceGenerator sgen)
```
    Creates a new SGStateInfo.
    
    Parameters:
    
    schema - the Schema to generate source for
    
    sgen - the SourceGenerator instance
- Method Detail
  - getPackageName
```
public String getPackageName()
```
    Get package used when creating new classes.
    
    Returns:
    
    Package used when creating new classes.
  - setPackageName
```
protected void setPackageName(String packageName)
```
    Set package used when creating new classes.
    
    Parameters:
    
    packageName - Package used when creating new classes.
  - bindSourceCode
```
public void bindSourceCode(Annotated annotated,
                           JClass[] classes)
```
    Binds the given Annotated structure with its generated source classes.
    
    Parameters:
    
    annotated - the Annotated structure to add JClass bindings for
    
    classes - the JClass[] to bind
  - storeImportedSourcesByName
```
public void storeImportedSourcesByName(Map<String,JClass> importedSourcesByName)
```
    Stores generated sources as processed within an imported schema.
    
    Parameters:
    
    importedSourcesByName - Generated sources as processed within an imported schema.
  - getSourceCode
```
public JClass[] getSourceCode(Annotated annotated)
```
    Returns the array of JClass for the given Annotated structure or null if no bindings have been specified for the given Structure.
    
    Parameters:
    
    annotated - the Annotated structure to search
    
    Returns:
    
    the JClass array
  - getSourceCode
```
public JClass getSourceCode(String className)
```
    Returns the JClass with the given name or null if no bindings have been specified for a JClass with the name.
    
    Parameters:
    
    className - the name of the JClass
    
    Returns:
    
    the JClass if found
  - getImportedSourceCode
```
public JClass getImportedSourceCode(String className)
```
    Returns the JClass with the given name or null if no bindings have been specified for a JClass with the name. This method consults with JClass instances imported through a Schema import only.
    
    Parameters:
    
    className - the name of the JClass
    
    Returns:
    
    the (imported) JClass if found
  - getMapping
```
public MappingRoot getMapping(String filename)
```
    Returns the Mapping file associated with the given filename.
    
    Parameters:
    
    filename - The filename to search for a Mapping File association
    
    Returns:
    
    the Mapping file.
  - getCDRFile
```
public Properties getCDRFile(String filename)
```
    Returns the CDRFile (Properties file) associated with the given filename.
    
    Parameters:
    
    filename - filename of the CDR file to be processed
    
    Returns:
    
    the Properties file.
  - getCDRFilenames
```
public Enumeration<String> getCDRFilenames()
```
    Returns the set of CDR file names.
    
    Returns:
    
    the set of CDR file names.
  - getMappingFilenames
```
public Enumeration<String> getMappingFilenames()
```
    Returns the set of mapping filenames.
    
    Returns:
    
    the set of mapping filenames.
  - getStatusCode
```
public int getStatusCode()
```
    Returns the current status.
    
    Returns:
    
    the current status.
  - getSourceGenerator
```
public SourceGenerator getSourceGenerator()
```
    Returns the SourceGenerator instance being used.
    
    Returns:
    
    the SourceGenerator instance being used.
  - getSuppressNonFatalWarnings
```
public boolean getSuppressNonFatalWarnings()
```
    Returns true if non-fatal warnings should be suppressed.
    
    Returns:
    
    true if non-fatal warnings should be suppressed.
  - setCDRFile
```
public void setCDRFile(String filename,
                       Properties props)
```
    Sets the CDR (ClassDescriptorResolver) file associated with the given filename.
    
    Parameters:
    
    filename - the filename associated with the CDR file
    
    props - the Properties file
  - setMapping
```
public void setMapping(String filename,
                       MappingRoot mapping)
```
    Sets the Mapping file associated with the given filename.
    
    Parameters:
    
    filename - the filename associated with the Mapping
    
    mapping - the MappingRoot
  - getDialog
```
public Dialog getDialog()
```
    Returns the Dialog used for interacting with the user.
    
    Returns:
    
    the Dialog, or null if none has been set.
  - setStatusCode
```
public void setStatusCode(int status)
```
    Sets the current status code to the given one.
    
    Parameters:
    
    status - the new status code
  - verbose
```
public boolean verbose()
```
    Returns the value of the verbose flag. A true value indicates that additional messages may be printed during processing.
    
    Returns:
    
    the value of the verbose flag.
  - getCurrentFactoryState
```
public FactoryState getCurrentFactoryState()
```
    Returns the current FactoryState that holds information about the classes being generated.
    
    Returns:
    
    the current FactoryState
  - setCurrentFactoryState
```
public void setCurrentFactoryState(FactoryState state)
```
    Sets the current FactoryState.
    
    Parameters:
    
    state - the current FactoryState
    
    See Also:
    
    getCurrentFactoryState()
  - getImportedSourcesByName
```
public Map<String,JClass> getImportedSourcesByName()
```
    Returns the sources as generated through XML schema imports.
    
    Returns:
    
    the sources as generated through XML schema imports.
  - getSourcesByName
```
public Map<String,JClass> getSourcesByName()
```
    Returns the sources as generated through XML schema imports.
    
    Returns:
    
    the sources as generated through XML schema imports.

Class SGStateInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.exolab.castor.builder.util.ClassInfoResolverImpl

Methods inherited from class java.lang.Object

Field Detail

NORMAL_STATUS

STOP_STATUS

Constructor Detail

SGStateInfo

Method Detail

getPackageName

setPackageName

bindSourceCode

storeImportedSourcesByName

getSourceCode

getSourceCode

getImportedSourceCode

getMapping

getCDRFile

getCDRFilenames

getMappingFilenames

getStatusCode

getSourceGenerator

getSuppressNonFatalWarnings

setCDRFile

setMapping

getDialog

setStatusCode

verbose

getCurrentFactoryState

setCurrentFactoryState

getImportedSourcesByName

getSourcesByName