oracle.odi.mapping.generation

Class CustomAST

java.lang.Object

oracle.odi.mapping.generation.AbstractSyntaxTree

oracle.odi.mapping.generation.CustomAST

public class CustomAST
extends AbstractSyntaxTree

A class to provide a customizable abstract syntax tree object to be used during code generation, to generate code from an arbitrary user-settable template and template substitution map.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.odi.mapping.generation.AbstractSyntaxTree

AbstractSyntaxTree.LogCounter

Method Summary

Modifier and Type	Method and Description
java.util.List	getChildren() Get the child object list for this substitution API object.
java.util.List	getExpressions() Get a list of expressions owned by this substitution API object.
ILocation	getSourceLocation() Get source location information for this AST, if any is defined, else return null.
ITechnology	getSourceTechnology() Get source technology information for this AST, if any is defined, else return null.
java.lang.String	getSourceTemplate() Get the source template.
java.lang.String	getSourceText() Get the source text.
ILocation	getTargetLocation() Get target location information for this AST, if any is defined, else return null.
ITechnology	getTargetTechnology() Get target technology information for this AST, if any is defined, else return null.
java.lang.String	getTargetText() Get the target text.
java.util.Map	getTemplateSubstitutionMap() Get the template substitution map.
java.lang.String	getText() Get the text.
java.lang.String	getType() Get the class type of this Object.
boolean	hasSourceAndTargetText() Return true if this object has both source and target text available, else false.

Methods inherited from class oracle.odi.mapping.generation.AbstractSyntaxTree

getCodeGenerationTemplate, getCodeGenerationTemplateName, getCustomTemplate, getKMName, getLeafLevelChildren, getMapPhysicalNode, getOrder, getParentAST, getParentOfType, getPropertyValue, getSourceLanguage, getTargetLanguage, hasCustomTemplate, isLeafLevelNode, isPushFromSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSourceTemplate

public java.lang.String getSourceTemplate()

Get the source template.

getSourceLocation

public ILocation getSourceLocation()

Get source location information for this AST, if any is defined, else return null.

Overrides:

getSourceLocation in class AbstractSyntaxTree

Throws:

GenerationException

getTargetLocation

public ILocation getTargetLocation()

Get target location information for this AST, if any is defined, else return null.

Overrides:

getTargetLocation in class AbstractSyntaxTree

Throws:

GenerationException

getSourceTechnology

public ITechnology getSourceTechnology()
                                throws GenerationException

Get source technology information for this AST, if any is defined, else return null.

Overrides:

getSourceTechnology in class AbstractSyntaxTree

Returns:

The source technology object.

Throws:

GenerationException

getTargetTechnology

public ITechnology getTargetTechnology()
                                throws GenerationException

Get target technology information for this AST, if any is defined, else return null.

Overrides:

getTargetTechnology in class AbstractSyntaxTree

Throws:

GenerationException

getText

public java.lang.String getText()
                         throws GenerationException

Get the text.

Overrides:

getText in class AbstractSyntaxTree

Returns:

The generated text.

Throws:

GenerationException

getTargetText

public java.lang.String getTargetText()
                               throws GenerationException

Get the target text.

Overrides:

getTargetText in class AbstractSyntaxTree

Returns:

The generated target text.

Throws:

GenerationException

getSourceText

public java.lang.String getSourceText()
                               throws GenerationException

Get the source text.

Overrides:

getSourceText in class AbstractSyntaxTree

Returns:

Throws:

GenerationException

getTemplateSubstitutionMap

public java.util.Map getTemplateSubstitutionMap()

Get the template substitution map.

Specified by:

getTemplateSubstitutionMap in class AbstractSyntaxTree

Returns:

The built-in template substitution hash map.

hasSourceAndTargetText

public boolean hasSourceAndTargetText()

Description copied from class: AbstractSyntaxTree

Return true if this object has both source and target text available, else false.

Overrides:

hasSourceAndTargetText in class AbstractSyntaxTree

getType

public java.lang.String getType()

Get the class type of this Object.

Specified by:

getType in class AbstractSyntaxTree

Returns:

A simple class type name for this object.

getChildren

public java.util.List getChildren()

Get the child object list for this substitution API object.

Specified by:

getChildren in class AbstractSyntaxTree

Returns:

The list of child objects.

getExpressions

public java.util.List getExpressions()

Description copied from class: AbstractSyntaxTree

Get a list of expressions owned by this substitution API object.

Specified by:

getExpressions in class AbstractSyntaxTree

Returns:

The list of expressions.