org.exolab.castor.builder
Class SGStateInfo

java.lang.Object
  extended by org.exolab.castor.builder.util.ClassInfoResolverImpl
      extended by org.exolab.castor.builder.SGStateInfo
All Implemented Interfaces:
ClassInfoResolver

 class SGStateInfo
extends ClassInfoResolverImpl

A class for maintaining state for the SourceGenerator

Version:
$Revision: 1.6 $ $Date: 2005/06/23 04:13:21 $
Author:
Keith Visco

Field Summary
static int NORMAL_STATUS
           
protected  java.lang.String packageName
          The package used when creating new classes.
static int STOP_STATUS
           
 
Constructor Summary
protected SGStateInfo(Schema schema, SourceGenerator sgen)
          Creates a new SGStateInfo
 
Method Summary
 void bindSourceCode(Annotated annotated, JClass[] classes)
          Binds the given Annotated structure with it's generated source classes
 java.util.Properties getCDRFile(java.lang.String filename)
          Returns the CDRFile (Properties file) associated with the given filename
 java.util.Enumeration getCDRFilenames()
          Returns the set of CDR file names
(package private)  FactoryState getCurrentFactoryState()
          Returns the current FactoryState that holds information about the classes being generated.
(package private)  Dialog getDialog()
          Returns the Dialog used for interacting with the user
 MappingRoot getMapping(java.lang.String filename)
          Returns the Mapping file associated with the given filename
 java.util.Enumeration getMappingFilenames()
          Returns the set of mapping filenames
(package private)  JClass getProcessed(java.lang.String className)
          Returns the processed JClass with the given name.
(package private)  Schema getSchema()
           
 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(java.lang.String className)
          Returns the JClass with the given name or null if no bindings have been specified for a JClass with the name.
(package private)  SourceGenerator getSourceGenerator()
          Returns the SourceGenerator instance being used
 int getStatusCode()
          Returns the current status
(package private)  boolean getSuppressNonFatalWarnings()
           
(package private)  void markAsProcessed(JClass jClass)
          Marks the given JClass as having been processed.
(package private)  boolean processed(JClass jClass)
          Returns true if the given JClass has been marked as processed
(package private)  boolean processed(java.lang.String className)
          Returns true if a JClass with the given name has been marked as processed
(package private)  boolean promptForOverwrite()
           
 void setCDRFile(java.lang.String filename, java.util.Properties props)
          Sets the CDR (ClassDescriptorResolver) file associated with the given filename
(package private)  void setCurrentFactoryState(FactoryState state)
          Sets the current FactoryState.
(package private)  void setDialog(Dialog dialog)
          Sets the Dialog used for interacting with the user
 void setMapping(java.lang.String filename, MappingRoot mapping)
          Sets the Mapping file associated with the given filename
(package private)  void setPromptForOverwrite(boolean promptForOverwrite)
           
(package private)  void setStatusCode(int status)
          Sets the current status code to the given one
(package private)  void setSuppressNonFatalWarnings(boolean suppressNonFatalWarnings)
           
(package private)  void setVerbose(boolean verbose)
          Sets whether or not the source code generator prints additional messages during generating source code
(package private)  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
See Also:
Constant Field Values

STOP_STATUS

public static final int STOP_STATUS
See Also:
Constant Field Values

packageName

protected java.lang.String packageName
The package used when creating new classes.

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

bindSourceCode

public void bindSourceCode(Annotated annotated,
                           JClass[] classes)
Binds the given Annotated structure with it's generated source classes

Parameters:
annotated - the Annotated structure to add JClass bindings for
classes - the JClass[] to bind

getProcessed

JClass getProcessed(java.lang.String className)
Returns the processed JClass with the given name. If no such JClass has been marked as processed, null is returned.

Parameters:
className - the JClass name to check against
Returns:
the JClass with the given name

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.

Returns:
the JClass array

getSourceCode

public JClass getSourceCode(java.lang.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

getMapping

public MappingRoot getMapping(java.lang.String filename)
Returns the Mapping file associated with the given filename

Returns:
the Mapping file

getCDRFile

public java.util.Properties getCDRFile(java.lang.String filename)
Returns the CDRFile (Properties file) associated with the given filename

Parameters:
filename -
Returns:
the Properties file

getCDRFilenames

public java.util.Enumeration getCDRFilenames()
Returns the set of CDR file names

Returns:
the set of CDR file names

getMappingFilenames

public java.util.Enumeration 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

markAsProcessed

void markAsProcessed(JClass jClass)
Marks the given JClass as having been processed.

Parameters:
jClass - the JClass to mark as having been processed.

processed

boolean processed(JClass jClass)
Returns true if the given JClass has been marked as processed

Parameters:
jClass - the JClass to check for being marked as processed

processed

boolean processed(java.lang.String className)
Returns true if a JClass with the given name has been marked as processed

Parameters:
className - the JClass name to check against

promptForOverwrite

boolean promptForOverwrite()

setPromptForOverwrite

void setPromptForOverwrite(boolean promptForOverwrite)

getSchema

Schema getSchema()

getSourceGenerator

SourceGenerator getSourceGenerator()
Returns the SourceGenerator instance being used


getSuppressNonFatalWarnings

boolean getSuppressNonFatalWarnings()

setSuppressNonFatalWarnings

void setSuppressNonFatalWarnings(boolean suppressNonFatalWarnings)

setCDRFile

public void setCDRFile(java.lang.String filename,
                       java.util.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(java.lang.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

Dialog getDialog()
Returns the Dialog used for interacting with the user

Returns:
the Dialog, or null if none has been set.

setDialog

void setDialog(Dialog dialog)
Sets the Dialog used for interacting with the user

Parameters:
dialog - the Dialog to use

setStatusCode

void setStatusCode(int status)
Sets the current status code to the given one

Parameters:
status - the new status code

setVerbose

void setVerbose(boolean verbose)
Sets whether or not the source code generator prints additional messages during generating source code

Parameters:
verbose - a boolean, when true indicates to print additional messages

verbose

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

FactoryState getCurrentFactoryState()
Returns the current FactoryState that holds information about the classes being generated.

Returns:
the current FactoryState

setCurrentFactoryState

void setCurrentFactoryState(FactoryState state)
Sets the current FactoryState.

Parameters:
state - the current FactoryState
See Also:
getCurrentFactoryState()


Intalio Inc. (C) 1999-2004. All rights reserved http://www.intalio.com