oracle.javatools.db.ddl

Class TokenGenerator

java.lang.Object

oracle.javatools.db.ddl.TokenGenerator

Direct Known Subclasses:

DefaultTokenGenerator, TokenGenerator.CascadeGenerator, TokenGenerator.CommentGenerator, TokenGenerator.DefaultSchemaGenerator, TokenGenerator.NameGenerator, TokenGenerator.ReplaceGenerator

public abstract class TokenGenerator
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenGenerator.CascadeGenerator {generate}
static class	TokenGenerator.CommentGenerator {quotedComment}
static class	TokenGenerator.DefaultSchemaGenerator Token generator for printing the name of the default schema for the underlying provider.
static class	TokenGenerator.NameGenerator {schema.name}
static class	TokenGenerator.ReplaceGenerator {replace}

Constructor Summary

Constructors

Constructor and Description
TokenGenerator()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<PropertyAction.ChildAction,java.util.Collection<java.lang.String>>	createPropertyMap(java.util.Collection<java.lang.String> alterModifyProps, java.util.Collection<java.lang.String> alterAddProps, java.util.Collection<java.lang.String> alterRemoveProps) Creates a Map suitable for returning from getAlterPropertiesProcessed(java.lang.String, oracle.javatools.db.DBObjectProvider) with the given property sets.
abstract java.lang.Object	evaluateToken(TokenContext context) Evaluates the token as an Object - used by [{token} PRINT THIS] type syntax where the returned result will be used to evaulate an if or for construct.
abstract void	generateToken(TokenContext context) Generates the token in to the context - i.e.
java.util.Map<PropertyAction.ChildAction,java.util.Collection<java.lang.String>>	getAlterPropertiesProcessed(java.lang.String type, DBObjectProvider pro) Gets all the properites that this TokenGenerator will generate.
protected oracle.javatools.db.ddl.TokenProcessor	getProcessor()
java.util.Collection<java.lang.String>	getPropertiesAltered(java.lang.String type, DBObjectProvider pro) Deprecated. replaced by getAlterPropertiesProcessed(java.lang.String, oracle.javatools.db.DBObjectProvider)
java.util.Collection<java.lang.String>	getPropertiesProcessed(java.lang.String type, DBObjectProvider pro) Returns the property names that are processed by this TokenGenerator.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenGenerator

public TokenGenerator()

Method Detail

generateToken

public abstract void generateToken(TokenContext context)

Generates the token in to the context - i.e. evaluates the token and appends the result to the context buffer.

evaluateToken

public abstract java.lang.Object evaluateToken(TokenContext context)

Evaluates the token as an Object - used by [{token} PRINT THIS] type syntax where the returned result will be used to evaulate an if or for construct.

getPropertiesProcessed

public java.util.Collection<java.lang.String> getPropertiesProcessed(java.lang.String type,
                                                                     DBObjectProvider pro)

Returns the property names that are processed by this TokenGenerator. By default an empty list is returned. DO NOT return null.

getPropertiesAltered

@Deprecated
public java.util.Collection<java.lang.String> getPropertiesAltered(java.lang.String type,
                                                                               DBObjectProvider pro)

Deprecated. replaced by getAlterPropertiesProcessed(java.lang.String, oracle.javatools.db.DBObjectProvider)

getAlterPropertiesProcessed

public java.util.Map<PropertyAction.ChildAction,java.util.Collection<java.lang.String>> getAlterPropertiesProcessed(java.lang.String type,
                                                                                                                    DBObjectProvider pro)

Gets all the properites that this TokenGenerator will generate. They are key'd in a Map by the TokenType that distinguishes the type of property token that each property appears in.

Parameters:

type - the object type

pro - the containing provider

Returns:

a Map of all the properties involed in generation

createPropertyMap

protected final java.util.Map<PropertyAction.ChildAction,java.util.Collection<java.lang.String>> createPropertyMap(java.util.Collection<java.lang.String> alterModifyProps,
                                                                                                                   java.util.Collection<java.lang.String> alterAddProps,
                                                                                                                   java.util.Collection<java.lang.String> alterRemoveProps)

Creates a Map suitable for returning from getAlterPropertiesProcessed(java.lang.String, oracle.javatools.db.DBObjectProvider) with the given property sets.

getProcessor

protected final oracle.javatools.db.ddl.TokenProcessor getProcessor()