A C D E F G H I K L M N O P Q R S T U V W

A

AbstractSandBaseTag - Class in org.sandev.generator.tags

Abstract base class for all SAND tag definitions.

AbstractSandBaseTag() - Constructor for class org.sandev.generator.tags.AbstractSandBaseTag

AbstractSandClassTag - Class in org.sandev.generator.tags

Extend AbstractSandBaseTag to allow for tags in classes.

AbstractSandClassTag() - Constructor for class org.sandev.generator.tags.AbstractSandClassTag

AbstractSandFieldTag - Class in org.sandev.generator.tags

Extend AbstractSandBaseTag to allow for tags in fields.

AbstractSandFieldTag() - Constructor for class org.sandev.generator.tags.AbstractSandFieldTag

AbstractSandGeneralTag - Class in org.sandev.generator.tags

Extend AbstractSandBaseTag to allow for tags that can be used at both the class and the field level.

AbstractSandGeneralTag() - Constructor for class org.sandev.generator.tags.AbstractSandGeneralTag

AbstractSandNodeTag - Class in org.sandev.generator.tags

Base class for all NodeTags.

AbstractSandNodeTag() - Constructor for class org.sandev.generator.tags.AbstractSandNodeTag

AbstractSandStructTag - Class in org.sandev.generator.tags

Base class for all StructTags.

AbstractSandStructTag() - Constructor for class org.sandev.generator.tags.AbstractSandStructTag

addSandAttrValToDecls(SandDecl[]) - Static method in class org.sandev.generator.AggregateGeneratorBase

SandAttrVal is treated as if it had a corresponding struct declaration for some purposes.

addTag(Tag) - Method in class org.sandev.generator.SandFieldDoc

Add a Tag to our collection.

AggregateGeneratorBase - Class in org.sandev.generator

Optional base class for generators which operate only on a single aggregate file, without side effects or merge requirements.

AggregateGeneratorBase() - Constructor for class org.sandev.generator.AggregateGeneratorBase

ALLSTRUCTS - Static variable in class org.sandev.generator.FuncSpecGenerator

annotations() - Method in class org.sandev.generator.SandClassDoc

Returns null.

annotations() - Method in class org.sandev.generator.SandFieldDoc

Returns null.

array - Variable in class org.sandev.generator.tags.FieldTagRef

True if this field is an array, false otherwise.

asAnnotationTypeDoc() - Method in class org.sandev.generator.SandClassDoc

Returns null.

asAnnotationTypeDoc() - Method in class org.sandev.generator.SandFieldDoc

Returns null.

asAnnotationTypeDoc() - Method in class org.sandev.generator.SandFieldType

Returns null.

asClassDoc() - Method in class org.sandev.generator.SandClassDoc

Not implemented; returns null.

asClassDoc() - Method in class org.sandev.generator.SandFieldType

Not implemented; returns null.

asParameterizedType() - Method in class org.sandev.generator.SandClassDoc

Returns null.

asParameterizedType() - Method in class org.sandev.generator.SandFieldDoc

Returns null.

asParameterizedType() - Method in class org.sandev.generator.SandFieldType

Returns null.

asTypeVariable() - Method in class org.sandev.generator.SandClassDoc

Returns null.

asTypeVariable() - Method in class org.sandev.generator.SandFieldDoc

Returns null.

asTypeVariable() - Method in class org.sandev.generator.SandFieldType

Returns null.

asWildcardType() - Method in class org.sandev.generator.SandClassDoc

Returns null.

asWildcardType() - Method in class org.sandev.generator.SandFieldDoc

Returns null.

asWildcardType() - Method in class org.sandev.generator.SandFieldType

Returns null.

attachToTree(SandDeclTreeWrapper, SandDeclTreeWrapper) - Static method in class org.sandev.generator.FuncSpecGenerator

Find the parent of the orphan and hook it up.

C

callGenerator(SandGenDecl, SandDecl[], SandProject, SandBuildDriver) - Static method in class org.sandev.generator.GenDriverDoclet

Call the build method of the given generator, with the given array of declarations.

canTransmit() - Method in class org.sandev.generator.tags.StructTagStructmessage

accessor for structTransmit

capitalize(String) - Static method in class org.sandev.generator.GeneratorCommon

Capitalizes the first letter of a string

charIter - Variable in class org.sandev.generator.RemainderTokenizer

Our character iterator.

cleanup(SandDecl[], File, boolean, String) - Method in class org.sandev.generator.AggregateGeneratorBase

Nuke the aggregate source file

cleanup(SandDecl[], File, boolean, String) - Method in class org.sandev.generator.DataManagerInfoGenerator

See the SandGenerator interface description and class comments for details.

cleanup(SandDecl[], File, boolean, String) - Method in class org.sandev.generator.FileGeneratorBase

Nuke the source files we generated.

cleanup(SandDecl[], File, boolean, String) - Method in class org.sandev.generator.FuncSpecGenerator

Clean up the files we wrote.

cleanup(SandDecl[], File, boolean, String) - Method in class org.sandev.generator.HelpFileGenerator

Clean up the file we wrote.

cleanup(SandDecl[], File, boolean, String) - Method in class org.sandev.generator.SandStringPersistConverterGenerator

See the SandGenerator interface description and class comments for details.

cleanupSecondaryFiles(SandDecl[], File) - Method in class org.sandev.generator.AggregateGeneratorBase

Clean up whatever was done in writeSecondaryFiles

collection - Variable in class org.sandev.generator.tags.StructTagVerbforms

Flag for collection

comment - Variable in class org.sandev.generator.tags.FieldTagDecimalize

Any comment text that was specified for this tag declaration

comment - Variable in class org.sandev.generator.tags.FieldTagEnumint

Any comment text that was specified for this tag declaration

comment - Variable in class org.sandev.generator.tags.FieldTagInvalid

Any comment text that was specified for this tag declaration

comment - Variable in class org.sandev.generator.tags.FieldTagRef

Any comment text that was specified for this tag declaration

comment - Variable in class org.sandev.generator.tags.FieldTagStringlength

Any comment text that was specified for this tag declaration

comment - Variable in class org.sandev.generator.tags.NodeTagCall

Any comment text that was specified for this tag declaration

comment - Variable in class org.sandev.generator.tags.NodeTagReceive

Any comment text that was specified for this tag declaration

comment - Variable in class org.sandev.generator.tags.NodeTagSend

Any comment text that was specified for this tag declaration

comment - Variable in class org.sandev.generator.tags.NodeTagSubscribe

Any comment text that was specified for this tag declaration

comments - Variable in class org.sandev.generator.SandClassDoc

comments - Variable in class org.sandev.generator.SandFieldDoc

commentText() - Method in class org.sandev.generator.SandClassDoc

commentText() - Method in class org.sandev.generator.SandFieldDoc

compareTo(Object) - Method in class org.sandev.generator.SandClassDoc

Not implemented; always returns 0.

compareTo(Object) - Method in class org.sandev.generator.SandFieldDoc

Not implemented; always returns 0.

configParam - Variable in class org.sandev.generator.tags.NodeTagCall

The configuration parameter that holds the messaging setup for a declared node instance.

configParam - Variable in class org.sandev.generator.tags.NodeTagSubscribe

The configuration parameter that holds the messaging setup for a declared node instance.

constantValue() - Method in class org.sandev.generator.SandFieldDoc

Constant objects aren't supported, so always return null

constantValueExpression() - Method in class org.sandev.generator.SandFieldDoc

Constant values aren't supported, so always return null

constructors() - Method in class org.sandev.generator.SandClassDoc

Not implemented; returns null.

constructors(boolean) - Method in class org.sandev.generator.SandClassDoc

Not implemented; returns null.

containingClass() - Method in class org.sandev.generator.SandClassDoc

All classes are assumed to be outer classes so return null

containingClass() - Method in class org.sandev.generator.SandFieldDoc

All classes are assumed to be outer classes so return null

containingPackage() - Method in class org.sandev.generator.SandClassDoc

Not implemented; returns null

containingPackage() - Method in class org.sandev.generator.SandFieldDoc

Not implemented; returns null

CONTEXT_CONFIGURATION - Static variable in class org.sandev.generator.GeneratorCommon

CONTEXT_CONTROL - Static variable in class org.sandev.generator.GeneratorCommon

CONTEXT_FRAMEWORK - Static variable in class org.sandev.generator.GeneratorCommon

CONTEXT_MESSAGING - Static variable in class org.sandev.generator.GeneratorCommon

CONTEXT_PERSISTENCE - Static variable in class org.sandev.generator.GeneratorCommon

CONTEXT_UI - Static variable in class org.sandev.generator.GeneratorCommon

copyfile(String, String) - Method in class org.sandev.generator.GeneratorCommon

Wrapper to access copyfile utility in the SandProject class.

CORENAME - Static variable in class org.sandev.generator.tags.FieldTagDateFormat

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.FieldTagDecimalize

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.FieldTagDefault

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.FieldTagEnumint

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.FieldTagFlags

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.FieldTagInvalid

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.FieldTagMetatype

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.FieldTagRange

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.FieldTagRef

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.FieldTagStringlength

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.GeneralTagHelp

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.GeneralTagPrintname

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.NodeTagCall

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.NodeTagImplement

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.NodeTagReceive

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.NodeTagSend

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.NodeTagSubscribe

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.StructTagStructmessage

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.StructTagSummaryfields

The core name of this tag.

CORENAME - Static variable in class org.sandev.generator.tags.StructTagVerbforms

The core name of this tag.

D

DataManagerInfoGenerator - Class in org.sandev.generator

Create the DataManagerInfo class.

DataManagerInfoGenerator() - Constructor for class org.sandev.generator.DataManagerInfoGenerator

decimals - Variable in class org.sandev.generator.tags.FieldTagDecimalize

The number of decimal places

DEFAULT_LINE_LENGTH - Static variable in class org.sandev.generator.GeneratorCommon

Default value at which to wrap comments and other output text.

DefaultSQLStructMapper - Class in org.sandev.generator

A default StructMapper with minimal tranformations, for mapping to relational database tables.

DefaultSQLStructMapper() - Constructor for class org.sandev.generator.DefaultSQLStructMapper

defaultStr - Variable in class org.sandev.generator.tags.FieldTagDefault

The declared default value

definesSerializableFields() - Method in class org.sandev.generator.SandClassDoc

Not implemented; returns false.

delete(SandDecl, File, String) - Method in class org.sandev.generator.FileGeneratorBase

Delete what you wrote, calling trackFileDelete for each file deleted.

delete(SandDecl, File, String) - Method in class org.sandev.generator.MessageClassGenerator

Delete the message source files.

delete(SandDecl, File, String) - Method in class org.sandev.generator.NodeClassGenerator

Delete the NodeBase source file.

delete(SandDecl, File, String) - Method in class org.sandev.generator.NodeInstClassGenerator

Delete the NodeInstance source file.

delete(SandDecl, File, String) - Method in class org.sandev.generator.PackageHTMLGenerator

Delete the package summary file

deletefile(String) - Method in class org.sandev.generator.GeneratorCommon

Wrapper to access deletefile utility in the SandProject class.

deleteFile(String) - Method in class org.sandev.generator.MessageClassGenerator

Factors the file deletion steps

description - Variable in class org.sandev.generator.tags.GeneralTagHelp

The descriptive help text.

dimension() - Method in class org.sandev.generator.SandClassDoc

dimension - Variable in class org.sandev.generator.SandFieldType

dimension() - Method in class org.sandev.generator.SandFieldType

displayFormat - Variable in class org.sandev.generator.tags.FieldTagDateFormat

The format string to use for display.

displayText - Variable in class org.sandev.generator.tags.FieldTagEnumint

The optional display text for this enumerated value.

dumpClassDocs(ClassDoc[]) - Static method in class org.sandev.generator.GenDriverDoclet

Dump out the given ClassDocs for debug purposes.

dumpGeneratedComments(PrintStream, FieldDoc, String) - Method in class org.sandev.generator.FuncSpecGenerator

Dump out any additional generated comments for this field.

E

editFormat - Variable in class org.sandev.generator.tags.FieldTagDateFormat

The format string to use for editing.

enumConstant - Variable in class org.sandev.generator.tags.FieldTagEnumint

The enumerated constant base name.

enumConstants() - Method in class org.sandev.generator.SandClassDoc

Returns null.

enumValStr - Variable in class org.sandev.generator.tags.FieldTagEnumint

The integer value for this enumerated value constant, in its originally declared String form.

exists(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagDateFormat

Returns true if the given field contains this tag, false otherwise.

exists(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagDecimalize

Returns true if the given field contains this tag, false otherwise.

exists(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagDefault

Returns true if the given field contains this tag, false otherwise.

exists(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagEnumint

Returns true if the given field contains this tag, false otherwise.

exists(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagFlags

Returns true if the given field contains this tag, false otherwise.

exists(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagInvalid

Returns true if the given field contains this tag, false otherwise.

exists(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagMetatype

Returns true if the given field contains this tag, false otherwise.

exists(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagRange

Returns true if the given field contains this tag, false otherwise.

exists(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagRef

Returns true if the given field contains this tag, false otherwise.

exists(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagStringlength

Returns true if the given field contains this tag, false otherwise.

exists(ProgramElementDoc) - Static method in class org.sandev.generator.tags.GeneralTagHelp

Returns true if the given program element contains this tag, false otherwise.

exists(ProgramElementDoc) - Static method in class org.sandev.generator.tags.GeneralTagPrintname

Returns true if the given program element contains this tag, false otherwise.

exists(ClassDoc) - Static method in class org.sandev.generator.tags.NodeTagCall

Returns true if the given class contains this tag, false otherwise.

exists(ClassDoc) - Static method in class org.sandev.generator.tags.NodeTagImplement

Returns true if the given field contains this tag, false otherwise.

exists(ClassDoc) - Static method in class org.sandev.generator.tags.NodeTagReceive

Returns true if the given class contains this tag, false otherwise.

exists(ClassDoc) - Static method in class org.sandev.generator.tags.NodeTagSend

Returns true if the given class contains this tag, false otherwise.

exists(ClassDoc) - Static method in class org.sandev.generator.tags.NodeTagSubscribe

Returns true if the given class contains this tag, false otherwise.

exists(ClassDoc) - Static method in class org.sandev.generator.tags.StructTagStructmessage

Returns true if the given field contains this tag, false otherwise.

exists(ClassDoc) - Static method in class org.sandev.generator.tags.StructTagSummaryfields

Returns true if the given field contains this tag, false otherwise.

exists(ClassDoc) - Static method in class org.sandev.generator.tags.StructTagVerbforms

Returns true if the given field contains this tag, false otherwise.

EXPAND_JAVA - Static variable in class org.sandev.generator.tags.FieldTagRange

use java standards for expanding the match expression

EXPAND_SQL - Static variable in class org.sandev.generator.tags.FieldTagRange

use SQL92 standards for expanding the match expression

extra - Variable in class org.sandev.generator.AggregateGeneratorBase

F

fieldName - Variable in class org.sandev.generator.SandFieldDoc

fieldName - Variable in class org.sandev.generator.tags.FieldTagDateFormat

The name of the field which had this dateformat associated with it.

fieldName - Variable in class org.sandev.generator.tags.FieldTagDecimalize

The name of the field which will be accessed in decimalized form.

fieldName - Variable in class org.sandev.generator.tags.FieldTagEnumint

The name of the field which had this enumint associated with it.

fieldName - Variable in class org.sandev.generator.tags.FieldTagFlags

The name of the field which had these flag associations.

fieldName - Variable in class org.sandev.generator.tags.FieldTagRange

The name of the field which had this range spec associated with it.

fieldName - Variable in class org.sandev.generator.tags.FieldTagRef

The name of the field which had this ref associated with it.

fieldName - Variable in class org.sandev.generator.tags.FieldTagStringlength

The name of the field which had this stringlength associated with it.

fieldNames - Variable in class org.sandev.generator.tags.StructTagSummaryfields

The array of field names

fields - Variable in class org.sandev.generator.SandClassDoc

fields() - Method in class org.sandev.generator.SandClassDoc

fields(boolean) - Method in class org.sandev.generator.SandClassDoc

Same as regular fields method with no params

FieldTagDateFormat - Class in org.sandev.generator.tags

Handle @sand.dateformat declarations.

FieldTagDateFormat() - Constructor for class org.sandev.generator.tags.FieldTagDateFormat

FieldTagDecimalize - Class in org.sandev.generator.tags

Handle @sand.decimalize declarations.

FieldTagDecimalize() - Constructor for class org.sandev.generator.tags.FieldTagDecimalize

FieldTagDefault - Class in org.sandev.generator.tags

Handle @sand.default declarations.

FieldTagDefault() - Constructor for class org.sandev.generator.tags.FieldTagDefault

FieldTagEnumint - Class in org.sandev.generator.tags

Handle @sand.enumint declarations.

FieldTagEnumint() - Constructor for class org.sandev.generator.tags.FieldTagEnumint

FieldTagFlags - Class in org.sandev.generator.tags

Handle @sand.flags field declarations.

FieldTagFlags() - Constructor for class org.sandev.generator.tags.FieldTagFlags

FieldTagInvalid - Class in org.sandev.generator.tags

Handle @sand.invalid declarations.

FieldTagInvalid() - Constructor for class org.sandev.generator.tags.FieldTagInvalid

FieldTagMetatype - Class in org.sandev.generator.tags

Handle @sand.metatype declarations.

FieldTagMetatype() - Constructor for class org.sandev.generator.tags.FieldTagMetatype

FieldTagRange - Class in org.sandev.generator.tags

Handle @sand.range declarations.

FieldTagRange() - Constructor for class org.sandev.generator.tags.FieldTagRange

FieldTagRef - Class in org.sandev.generator.tags

Handle @sand.ref declarations.

FieldTagRef() - Constructor for class org.sandev.generator.tags.FieldTagRef

FieldTagStringlength - Class in org.sandev.generator.tags

Handle @sand.stringlength declarations.

FieldTagStringlength() - Constructor for class org.sandev.generator.tags.FieldTagStringlength

fieldType - Variable in class org.sandev.generator.tags.FieldTagDecimalize

The type of the field which will be accessed in decimalized form.

fieldType - Variable in class org.sandev.generator.tags.FieldTagRef

The type of the field which had this ref associated with it.

FileGeneratorBase - Class in org.sandev.generator

Optional base class for generators which operate only on files, without side effects or merge requirements.

FileGeneratorBase() - Constructor for class org.sandev.generator.FileGeneratorBase

filterDecls(SandDecl[]) - Method in class org.sandev.generator.InstClassEnumGenerator

Remove any declarations that are referencing instances used by the platform since we haven't built that yet.

filterHTMLLine(String) - Method in class org.sandev.generator.FuncSpecGenerator

If the given line contains a node documentation link to be substituted then make that happen.

filterHTMLLine(String) - Method in class org.sandev.generator.GeneratorCommon

Called from writeHTMLContents for each line being written to provide an opportunity to change the text.

findClass(String) - Method in class org.sandev.generator.SandClassDoc

Not implemented; returns null.

findStructDeclByShortname(String) - Method in class org.sandev.generator.GeneratorCommon

Find a struct decl by its short name.

firstSentenceTags() - Method in class org.sandev.generator.SandClassDoc

Not implemented; returns null.

firstSentenceTags() - Method in class org.sandev.generator.SandFieldDoc

Not implemented; returns null.

firstSentenceTags() - Method in class org.sandev.generator.SandTag

stubbed

flagBinary - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for binary

flagCollapsible - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for collapsible

flagDisplayID - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for displayID

flagDynamicSelect - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for dynamicselect

flagEncrypt - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for encrypt

flagHasbool - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for hasbool

flagInternal - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for internal

flagIsbool - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for isbool

flagNoecho - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for noecho

flagNofind - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for nofind

flagNorefdisplay - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for flagNorefdisplay

flagNumseparator - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for numseparator

flagObfuscate - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for obfuscate

flagStack - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for stack

flagStringpersist - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for stringpersist

flagSummaryedit - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for flagSummaryedit

flagTreeChildren - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for treechildren

flagTreeParent - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for treeparent

flagUnique - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for unique

flagWildcardmatch - Variable in class org.sandev.generator.tags.FieldTagFlags

Flag for wildcardmatch

FuncSpecGenerator - Class in org.sandev.generator

Write out a functional specification website off the driving project docs area.

FuncSpecGenerator() - Constructor for class org.sandev.generator.FuncSpecGenerator

G

GenDriverDoclet - Class in org.sandev.generator

Bridge between the SAND build, the doclet API, and the SandGenerator API.

GenDriverDoclet() - Constructor for class org.sandev.generator.GenDriverDoclet

GeneralTagHelp - Class in org.sandev.generator.tags

Handle @sand.help declarations.

GeneralTagHelp() - Constructor for class org.sandev.generator.tags.GeneralTagHelp

GeneralTagPrintname - Class in org.sandev.generator.tags

Handle @sand.printname declarations.

GeneralTagPrintname() - Constructor for class org.sandev.generator.tags.GeneralTagPrintname

generate(SandDecl[], File, boolean, Collection, String) - Method in class org.sandev.generator.AggregateGeneratorBase

Write the aggregate source file

generate(SandDecl[], File, boolean, Collection, String) - Method in class org.sandev.generator.DataManagerInfoGenerator

See the SandGenerator interface description and class comments for details.

generate(SandDecl[], File, boolean, Collection, String) - Method in class org.sandev.generator.FileGeneratorBase

Write the NodeBase source files if the declaration changed.

generate(SandDecl[], File, boolean, Collection, String) - Method in class org.sandev.generator.FuncSpecGenerator

Create the functional specification website files.

generate(SandDecl[], File, boolean, Collection, String) - Method in class org.sandev.generator.HelpFileGenerator

Create the helpfile html document with anchors for each struct and field based on their print names.

generate(SandDecl[], File, boolean, Collection, String) - Method in class org.sandev.generator.SandStringPersistConverterGenerator

See the SandGenerator interface description and class comments for details.

GeneratorCommon - Class in org.sandev.generator

Common generator utilities, extend from here or call directly

GeneratorCommon() - Constructor for class org.sandev.generator.GeneratorCommon

getAppStructDecls(SandDecl[], String) - Static method in class org.sandev.generator.FuncSpecGenerator

Given an array of declarations, return all the struct declarations for the app, as identified by the source prefix.

getCharIter() - Method in class org.sandev.generator.RemainderTokenizer

accessor for charIter

getClassDocForRef(String) - Static method in class org.sandev.generator.HelpFileGenerator

Given the class name of a struct, return the the associated ClassDoc by looking it up in the global struct decls.

getCodeConstant() - Method in class org.sandev.generator.tags.FieldTagEnumint

Return the code constant

getCollectionMessageFields(String, String) - Method in class org.sandev.generator.MessageClassGenerator

Return the fields for a SandQueryMessage.

getComment() - Method in class org.sandev.generator.tags.FieldTagDecimalize

accessor for comment

getComment() - Method in class org.sandev.generator.tags.FieldTagEnumint

accessor for comment

getComment() - Method in class org.sandev.generator.tags.FieldTagInvalid

accessor for comment

getComment() - Method in class org.sandev.generator.tags.FieldTagRef

accessor for comment

getComment() - Method in class org.sandev.generator.tags.FieldTagStringlength

accessor for comment

getComment() - Method in class org.sandev.generator.tags.NodeTagCall

accessor for comment

getComment() - Method in class org.sandev.generator.tags.NodeTagReceive

accessor for comment

getComment() - Method in class org.sandev.generator.tags.NodeTagSend

accessor for comment

getComment() - Method in class org.sandev.generator.tags.NodeTagSubscribe

accessor for comment

getConfigParam() - Method in class org.sandev.generator.tags.NodeTagCall

accessor for configParam

getConfigParam() - Method in class org.sandev.generator.tags.NodeTagSubscribe

accessor for configParam

getCoreMethodSig(boolean) - Method in class org.sandev.generator.tags.NodeTagCall

Return the undecorated signature of the messaging method generated for this tag.

getCoreMethodSig(boolean) - Method in class org.sandev.generator.tags.NodeTagSend

Return the undecorated signature of the messaging method generated for this tag.

getDecimals() - Method in class org.sandev.generator.tags.FieldTagDecimalize

accessor for decimals

getDeclaredFields(ClassDoc, boolean, int) - Static method in class org.sandev.generator.GeneratorCommon

Return an ArrayList containing all the fields for this class, including inherited fields if requested.

getDefaultStr() - Method in class org.sandev.generator.tags.FieldTagDefault

accessor for defaultStr

getDescription() - Method in class org.sandev.generator.tags.GeneralTagHelp

accessor for description

getDisplayFormat() - Method in class org.sandev.generator.tags.FieldTagDateFormat

accessor for displayFormat

getDisplayText() - Method in class org.sandev.generator.tags.FieldTagEnumint

accessor for displayText

getDMIFileName(File) - Method in class org.sandev.generator.DataManagerInfoGenerator

Return the file spec for the DataManagerInfo file

getEditFormat() - Method in class org.sandev.generator.tags.FieldTagDateFormat

accessor for editFormat

getEnumConstant() - Method in class org.sandev.generator.tags.FieldTagEnumint

accessor for enumConstant

getEnumVal() - Method in class org.sandev.generator.tags.FieldTagEnumint

Return the enumeration value as an integer.

getEnumValStr() - Method in class org.sandev.generator.tags.FieldTagEnumint

accessor for enumValStr

getExpandedExpression(String, int) - Method in class org.sandev.generator.tags.FieldTagRange

Expand this range expression into a conditional expression by substituting in the given value as needed, and translating the conditional operators as needed.

getExtra() - Method in class org.sandev.generator.AggregateGeneratorBase

accessor for extra

getFieldName() - Method in class org.sandev.generator.tags.FieldTagDateFormat

accessor for fieldName

getFieldName() - Method in class org.sandev.generator.tags.FieldTagDecimalize

accessor for fieldName

getFieldName() - Method in class org.sandev.generator.tags.FieldTagEnumint

accessor for fieldName

getFieldName() - Method in class org.sandev.generator.tags.FieldTagFlags

accessor for fieldName

getFieldName() - Method in class org.sandev.generator.tags.FieldTagRange

accessor for fieldName

getFieldName() - Method in class org.sandev.generator.tags.FieldTagRef

accessor for fieldName

getFieldName() - Method in class org.sandev.generator.tags.FieldTagStringlength

accessor for fieldName

getFieldNames() - Method in class org.sandev.generator.tags.StructTagSummaryfields

accessor for fieldNames

getFieldNameText(FieldDoc) - Method in class org.sandev.generator.FuncSpecGenerator

Return the display text for this field

getFields(ClassDoc, boolean, int) - Static method in class org.sandev.generator.GeneratorCommon

Given a ClassDoc, return all the fields for it, including any synthetic fields generated for SAND.

getFieldTagDateFormat(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagDateFormat

Factory method for retrieving a new instance given a FieldDoc.

getFieldTagDecimalize(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagDecimalize

Factory method for retrieving a new instance given a FieldDoc.

getFieldTagDefault(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagDefault

Factory method for retrieving a new instance given a FieldDoc.

getFieldTagEnumints(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagEnumint

Factory method to return the FieldTagEnumint elements of a field.

getFieldTagFlags(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagFlags

Factory method for retrieving a new instance given a FieldDoc.

getFieldTagInvalid(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagInvalid

Factory method for retrieving a new instance given a FieldDoc.

getFieldTagMetatype(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagMetatype

Factory method for retrieving a new instance given a FieldDoc.

getFieldTagRange(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagRange

Factory method for retrieving a new instance given a FieldDoc.

getFieldTagRef(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagRef

Factory method for retrieving a new instance given a FieldDoc.

getFieldTagStringlength(FieldDoc) - Static method in class org.sandev.generator.tags.FieldTagStringlength

Factory method for retrieving a new instance given a FieldDoc.

getFieldType() - Method in class org.sandev.generator.tags.FieldTagDecimalize

accessor for fieldType

getFieldType() - Method in class org.sandev.generator.tags.FieldTagRef

accessor for fieldType

getFileSpec(File) - Method in class org.sandev.generator.AggregateGeneratorBase

Return the full file specification we of the file we are generating.

getFileSpec(File) - Method in class org.sandev.generator.InstClassEnumGenerator

Return lastApp/src/org/xyz/util/AppInstanceClassEnumerator.java or the equivalent filespec.

getFirstHTMLSentence(String) - Method in class org.sandev.generator.FuncSpecGenerator

Return the first sentence from the body of the given HTML file.

getFlagStrings() - Method in class org.sandev.generator.tags.FieldTagFlags

Return a String array of all the flags declared.

getFrameworkMethodSig(boolean) - Method in class org.sandev.generator.tags.NodeTagReceive

Return the undecorated signature of the messaging method generated for this tag.

getFrameworkMethodSig(boolean) - Method in class org.sandev.generator.tags.NodeTagSubscribe

Return the undecorated signature of the messaging method generated for this tag.

getGeneralTagHelp(ProgramElementDoc) - Static method in class org.sandev.generator.tags.GeneralTagHelp

Factory method for retrieving a new instance given a program element doc object.

getGeneralTagPrintname(ProgramElementDoc) - Static method in class org.sandev.generator.tags.GeneralTagPrintname

Factory method for retrieving a new instance given a program element doc object.

getGenFileName(SandDecl) - Method in class org.sandev.generator.NodeClassGenerator

Return the name of the file we are generating from this declaration.

getGenFileName(SandDecl) - Method in class org.sandev.generator.NodeInstClassGenerator

Return the name of the file we are generating from this declaration.

getHelpfile(boolean) - Method in class org.sandev.generator.HelpFileGenerator

Return the name of the helpfile we are writing.

getImplDescription() - Method in class org.sandev.generator.tags.NodeTagImplement

Assuming this instance has been initialized, return the description of the implementations that were declared.

getInboundMessage() - Method in class org.sandev.generator.tags.NodeTagReceive

accessor for inboundMessage

getInboundMessage() - Method in class org.sandev.generator.tags.NodeTagSubscribe

accessor for inboundMessage

getInheritanceHierarchy(ClassDoc, boolean) - Static method in class org.sandev.generator.GeneratorCommon

Returns the inheritance hierarchy for the given ClassDoc.

getInput() - Method in class org.sandev.generator.RemainderTokenizer

accessor for input

getInstanceConfigParam() - Method in class org.sandev.generator.tags.NodeTagCall

Return the name of the NodeInstance data member which will hold the messaging configuration for this declaration.

getInstanceConfigParam() - Method in class org.sandev.generator.tags.NodeTagReceive

Return the name of the NodeInstance data member which will hold the messaging configuration for this declaration.

getInstanceConfigParam() - Method in class org.sandev.generator.tags.NodeTagSend

Return the name of the NodeInstance data member which will hold the messaging configuration for this declaration.

getInstanceConfigParam() - Method in class org.sandev.generator.tags.NodeTagSubscribe

Return the name of the NodeInstance data member which will hold the messaging configuration for this declaration.

getInstanceName(String) - Static method in class org.sandev.generator.InstanceGeneratorBase

Given the name of a NodeDecl, return the name of the instance.

getInvalidArrayStr() - Method in class org.sandev.generator.tags.FieldTagInvalid

Get the invalid value for an array as a String.

getInvalidStr() - Method in class org.sandev.generator.tags.FieldTagInvalid

accessor for invalidStr

getLastAppProject() - Method in class org.sandev.generator.GeneratorCommon

Return the SandProject just before the triggering build project.

getLastUtilDir() - Method in class org.sandev.generator.GeneratorCommon

Return the name of the util directory of the last project before the triggering deployment build.

getLineCounter() - Method in class org.sandev.generator.LineCountPrintStream

getLongInstanceName(String) - Static method in class org.sandev.generator.GeneratorCommon

Given the fully qualified name of a struct or node declaration, return the fully qualified name of the corresponding instance message.

getMappedFieldName(ClassDoc, FieldDoc) - Method in class org.sandev.generator.DefaultSQLStructMapper

Use the field name as the table column name.

getMappedFieldName(ClassDoc, FieldDoc) - Method in class org.sandev.generator.PostgreSQLStructMapper

PostgreSQL prevents some reserved words from being used as column names unless they're quoted.

getMappedFieldName(ClassDoc, FieldDoc) - Method in interface org.sandev.generator.StructMapper

Returns the mapped name for the field.

getMappedFieldRelation(ClassDoc, FieldDoc) - Method in class org.sandev.generator.DefaultSQLStructMapper

An array relation is the parent struct name, followed by an underscore, followed by the field name.

getMappedFieldRelation(ClassDoc, FieldDoc) - Method in interface org.sandev.generator.StructMapper

Returns the mapped name for the relationship between the struct and the reference array field values.

getMappedFieldRelationChild(ClassDoc, FieldDoc) - Method in class org.sandev.generator.DefaultSQLStructMapper

In an array relation, the child object column is named child.

getMappedFieldRelationChild(ClassDoc, FieldDoc) - Method in interface org.sandev.generator.StructMapper

In the relation between the struct and the reference array field values, return the name of the field representing the array field value.

getMappedFieldRelationIndex(ClassDoc, FieldDoc) - Method in class org.sandev.generator.DefaultSQLStructMapper

In an array relation, the ordering column would be called index, except that tends to be a reserved word, so its called aindex.

getMappedFieldRelationIndex(ClassDoc, FieldDoc) - Method in interface org.sandev.generator.StructMapper

In the relation between the struct and the reference array field values, return the name of the field representing the ordering information for the array values.

getMappedFieldRelationParent(ClassDoc, FieldDoc) - Method in class org.sandev.generator.DefaultSQLStructMapper

In an array relation, the parent object column is named parent.

getMappedFieldRelationParent(ClassDoc, FieldDoc) - Method in interface org.sandev.generator.StructMapper

In the relation between the struct and the reference array field values, return the name of the field representing the struct instance.

getMappedFieldType(ClassDoc, FieldDoc) - Method in class org.sandev.generator.DefaultSQLStructMapper

Return the corresponding type for the field.

getMappedFieldType(ClassDoc, FieldDoc) - Method in class org.sandev.generator.MySQLStructMapper

getMappedFieldType(ClassDoc, FieldDoc) - Method in class org.sandev.generator.PostgreSQLStructMapper

Field overrides for PostgreSQL.

getMappedFieldType(ClassDoc, FieldDoc) - Method in interface org.sandev.generator.StructMapper

Returns the mapped type for the field.

getMappedStructName(ClassDoc) - Method in class org.sandev.generator.DefaultSQLStructMapper

Use the base struct name as the name of the table.

getMappedStructName(ClassDoc) - Method in interface org.sandev.generator.StructMapper

Returns the mapped name for the struct.

getMatchExpr() - Method in class org.sandev.generator.tags.FieldTagRange

accessor for matchExpr

getMaxLength() - Method in class org.sandev.generator.tags.FieldTagStringlength

Return the maximum length as an integer.

getMaxLengthStr() - Method in class org.sandev.generator.tags.FieldTagStringlength

accessor for maxLengthStr

getMessageName(String, boolean) - Static method in class org.sandev.generator.PackageHTMLGenerator

If link is true, then return the hyperlink for the struct doc, otherwise return the plain message name.

getMetatype(FieldDoc) - Static method in class org.sandev.generator.HelpFileGenerator

Given a field doc, return its metatype in parentheses, or the empty string if no metatype defined.

getMetatype() - Method in class org.sandev.generator.tags.FieldTagMetatype

acessor for metatype

getName() - Method in class org.sandev.generator.tags.FieldTagDateFormat

Return our tag name

getName() - Method in class org.sandev.generator.tags.FieldTagDecimalize

Return our tag name

getName() - Method in class org.sandev.generator.tags.FieldTagDefault

Return our tag name

getName() - Method in class org.sandev.generator.tags.FieldTagEnumint

Return our tag name

getName() - Method in class org.sandev.generator.tags.FieldTagFlags

Return our tag name

getName() - Method in class org.sandev.generator.tags.FieldTagInvalid

Return our tag name

getName() - Method in class org.sandev.generator.tags.FieldTagMetatype

Return our tag name

getName() - Method in class org.sandev.generator.tags.FieldTagRange

Return our tag name

getName() - Method in class org.sandev.generator.tags.FieldTagRef

Return our tag name

getName() - Method in class org.sandev.generator.tags.FieldTagStringlength

Return our tag name

getName() - Method in class org.sandev.generator.tags.GeneralTagHelp

Return our tag name

getName() - Method in class org.sandev.generator.tags.GeneralTagPrintname

Return our tag name

getName() - Method in class org.sandev.generator.tags.NodeTagCall

Return our tag name

getName() - Method in class org.sandev.generator.tags.NodeTagImplement

Return our tag name

getName() - Method in class org.sandev.generator.tags.NodeTagReceive

Return our tag name

getName() - Method in class org.sandev.generator.tags.NodeTagSend

Return our tag name

getName() - Method in class org.sandev.generator.tags.NodeTagSubscribe

Return our tag name

getName() - Method in class org.sandev.generator.tags.StructTagStructmessage

Return our tag name

getName() - Method in class org.sandev.generator.tags.StructTagSummaryfields

Return our tag name

getName() - Method in class org.sandev.generator.tags.StructTagVerbforms

Return our tag name

getNodeTagCalls(ClassDoc) - Static method in class org.sandev.generator.tags.NodeTagCall

Factory method to return the NodeTagCall elements of a class.

getNodeTagImplement(ClassDoc) - Static method in class org.sandev.generator.tags.NodeTagImplement

Factory method for retrieving a new instance given a ClassDoc.

getNodeTagReceives(ClassDoc) - Static method in class org.sandev.generator.tags.NodeTagReceive

Factory method to return the NodeTagReceive elements of a class.

getNodeTagSends(ClassDoc) - Static method in class org.sandev.generator.tags.NodeTagSend

Factory method to return the NodeTagSend elements of a class.

getNodeTagSubscribes(ClassDoc) - Static method in class org.sandev.generator.tags.NodeTagSubscribe

Factory method to return the NodeTagSubscribe elements of a class.

getNormLength() - Method in class org.sandev.generator.tags.FieldTagStringlength

Return the normal length as an integer.

getNormLengthStr() - Method in class org.sandev.generator.tags.FieldTagStringlength

accessor for normLengthStr

getNumDecimals() - Method in class org.sandev.generator.tags.FieldTagDecimalize

Return the number of decimals as an integer.

getOutboundMessage() - Method in class org.sandev.generator.tags.NodeTagCall

accessor for outboundMessage

getOutboundMessage() - Method in class org.sandev.generator.tags.NodeTagSend

accessor for outboundMessage

getOutboundMessageShortName() - Method in class org.sandev.generator.tags.NodeTagCall

Return the short name of the outbound message name

getPackageName(ClassDoc) - Method in class org.sandev.generator.MessageClassGenerator

Returns the package declaration

getPrintnameForField(String, FieldDoc[]) - Method in class org.sandev.generator.InstanceGeneratorBase

Given a fieldname, return the printname for it.

getPrintnameStr() - Method in class org.sandev.generator.tags.GeneralTagPrintname

accessor for printnameStr

getPrintStream(String) - Static method in class org.sandev.generator.GeneratorCommon

Given a filename, return a PrintStream for it.

getQueryMessageFields(String, String) - Method in class org.sandev.generator.MessageClassGenerator

Return the fields for a SandQueryMessage.

getRange(FieldDoc) - Static method in class org.sandev.generator.HelpFileGenerator

Given a FieldDoc, return the range specification, or the empty string if no range defined.

getRawCommentText() - Method in class org.sandev.generator.SandClassDoc

Equivalent to commentText().

getRawCommentText() - Method in class org.sandev.generator.SandFieldDoc

Equivalent to commentText().

getRefFieldName() - Method in class org.sandev.generator.tags.FieldTagRef

Return the name of the field in the referenced object which is used as a key reference.

getRefKey() - Method in class org.sandev.generator.tags.FieldTagRef

accessor for refKey

getRefLongMessageClassName() - Method in class org.sandev.generator.tags.FieldTagRef

Return the fully qualified class name of the referenced message.

getRefShortMessageClassName() - Method in class org.sandev.generator.tags.FieldTagRef

Return the short class name of the referenced message.

getRemainder() - Method in class org.sandev.generator.RemainderTokenizer

Return the remaining text verbatim.

getReturnMessage() - Method in class org.sandev.generator.tags.NodeTagCall

accessor for returnMessage

getReturnMessage() - Method in class org.sandev.generator.tags.NodeTagReceive

accessor for returnMessage

getReturnMessageShortName() - Method in class org.sandev.generator.tags.NodeTagCall

Return the short name of the returned message name

getSandProject(File) - Method in class org.sandev.generator.GeneratorCommon

Return the current SandProject.

getShortInstanceName(String) - Static method in class org.sandev.generator.GeneratorCommon

Given either a short or fully qualified name of a struct or node declaration, return the short name of the associated instance message.

getSortedShortNames(SandDecl[]) - Method in class org.sandev.generator.InstClassEnumGenerator

It is critical that the short and long message names be in the same sorted order so the lookup works.

getSPCFileName(File) - Method in class org.sandev.generator.SandStringPersistConverterGenerator

Return the file spec for the SandPersistConverter file

getSrcBase(SandDecl) - Method in class org.sandev.generator.MessageClassGenerator

Return the base of the filename for where the message source should be written.

getStringlen(FieldDoc) - Static method in class org.sandev.generator.HelpFileGenerator

Given a FieldDoc, return the average and maximum length of the string.

getStructTagStructmessage(ClassDoc) - Static method in class org.sandev.generator.tags.StructTagStructmessage

Factory method for retrieving a new instance