com.phenix.pct
Class GenericExecuteOptions

java.lang.Object
  com.phenix.pct.GenericExecuteOptions

public class GenericExecuteOptions
extends Object

Constructor Summary

GenericExecuteOptions(org.apache.tools.ant.Project p)

Method Summary

void	addOption(PCTRunOption option) Adds a new command line option
void	addOutputParameter(OutputParameter param) Add a new output param which will be passed to progress procedure
void	addParameter(RunParameter param) Adds a new parameter which can be read by the called Progress procedure
void	addPCTConnection(PCTConnection dbConn) Adds a database connection
void	addPCTRunOption(PCTRunOption option)
org.apache.tools.ant.types.Path	createPropath() Creates a new Path instance
File	getBaseDir()
int	getCenturyYearOffset()
protected List	getCmdLineParameters()
String	getCpInternal()
String	getCpStream()
List	getDBConnections() Returns list of database connections.
List	getDbConnList()
int	getDebugReady()
int	getDirSize()
File	getIniFile()
int	getInputChars()
int	getMaximumMemory()
int	getMessageBufferSize()
String	getNumdec()
String	getNumsep()
List	getOptions() Returns list of command line options.
List	getOutputParameters() Returns list of output parameters to be filled by the called Progress procedure.
String	getParameter()
List	getParameters() Returns list of parameters passed to the called Progress procedure.
File	getParamFile()
String	getProcedure()
org.apache.tools.ant.types.Path	getPropath()
String	getResultProperty()
List	getRunParameters()
int	getStackSize()
File	getTempDir()
int	getToken()
int	getTtBufferSize()
boolean	isBatchMode()
boolean	isCompileUnderscore()
boolean	isDebugPCT()
boolean	isGraphMode()
void	setBaseDir(File baseDir) The directory in which the Progress runtime should be executed.
void	setCenturyYearOffset(int centuryYearOffset) Century year offset (-yy attribute)
void	setCompileUnderscore(boolean compUnderscore) If files beginning with an underscore should be compiled (-zn option) See POSSE documentation for more details
void	setCpInternal(String cpInternal) Internal code page (-cpinternal attribute)
void	setCpStream(String cpStream) Stream code page (-cpstream attribute)
void	setDebugPCT(boolean debugPCT) Turns on/off debugging mode (keeps Progress temp files on disk)
void	setDebugReady(int debugReady) Port number on which debugger should connect (-debugReady parameter)
void	setDirSize(int dirSize) The number of compiled procedure directory entries (-D attribute)
void	setFailOnError(boolean failOnError)
void	setGraphicalMode(boolean graphMode) Graphical mode on/off (call to _progres or prowin32)
void	setIniFile(File iniFile) Sets .ini file to use (-basekey INI -ininame xxx)
void	setInputChars(int inputChars) The number of characters allowed in a single statement (-inp attribute)
void	setMaximumMemory(int maximumMemory) The amount of memory allocated for r-code segments
void	setMsgBufferSize(int msgBufSize) Message buffer size (-Mm attribute)
void	setNumDec(String numdec) Decimal separator (-numdec attribute)
void	setNumSep(String numsep) Thousands separator (-numsep attribute)
void	setParameter(String param) Parameter (-param attribute)
void	setParamFile(File pf) Parameter file (-pf attribute)
void	setProcedure(String procedure)
void	setPropath(org.apache.tools.ant.types.Path propath) Set the propath to be used when running the procedure
void	setResultProperty(String resultProperty) Sets the name of a property in which the return valeur of the Progress procedure should be stored.
void	setStackSize(int stackSize) The size of the stack in 1KB units.
void	setTempDir(File tempDir) Temporary directory for Progress runtime (-T parameter)
void	setToken(int token) The number of tokens allowed in a 4GL statement (-tok attribute)
void	setTTBufferSize(int ttBufferSize) Buffer Size for Temporary Tables (-Bt attribute)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericExecuteOptions

public GenericExecuteOptions(org.apache.tools.ant.Project p)

Method Detail

addPCTConnection

public void addPCTConnection(PCTConnection dbConn)

Adds a database connection

Parameters:

dbConn - Instance of PCTConnection class

getDBConnections

public List getDBConnections()

Returns list of database connections.

Returns:

List of PCTConnection objects. Empty list if no DB connections

addOption

public void addOption(PCTRunOption option)

Adds a new command line option

Parameters:

option - Instance of PCTRunOption class

addPCTRunOption

public void addPCTRunOption(PCTRunOption option)

Parameters:

option -

See Also:

PCTRun.addOption(PCTRunOption)

getOptions

public List getOptions()

Returns list of command line options.

Returns:

List of PCTRunOption objects. Empty list if no options.

addParameter

public void addParameter(RunParameter param)

Adds a new parameter which can be read by the called Progress procedure

Parameters:

param - Instance of RunParameter class

getParameters

public List getParameters()

Returns list of parameters passed to the called Progress procedure.

Returns:

List of RunParameters objects. Empty list if no parameter.

addOutputParameter

public void addOutputParameter(OutputParameter param)

Add a new output param which will be passed to progress procedure

Parameters:

param - Instance of OutputParameter

Since:

PCT 0.14

getOutputParameters

public List getOutputParameters()

Returns list of output parameters to be filled by the called Progress procedure.

Returns:

List of OutputParameter objects. Empty list if no parameter.

setPropath

public void setPropath(org.apache.tools.ant.types.Path propath)

Set the propath to be used when running the procedure

Parameters:

propath - an Ant Path object containing the propath

createPropath

public org.apache.tools.ant.types.Path createPropath()

Creates a new Path instance

Returns:

Path

setParamFile

public void setParamFile(File pf)

Parameter file (-pf attribute)

Parameters:

pf - File

getParamFile

public File getParamFile()

setNumSep

public void setNumSep(String numsep)

Thousands separator (-numsep attribute)

Parameters:

numsep - String

setNumDec

public void setNumDec(String numdec)

Decimal separator (-numdec attribute)

Parameters:

numdec - String

setParameter

public void setParameter(String param)

Parameter (-param attribute)

Parameters:

param - String

setDebugPCT

public void setDebugPCT(boolean debugPCT)

Turns on/off debugging mode (keeps Progress temp files on disk)

Parameters:

debugPCT - boolean

setCompileUnderscore

public void setCompileUnderscore(boolean compUnderscore)

If files beginning with an underscore should be compiled (-zn option) See POSSE documentation for more details

Parameters:

compUnderscore - boolean

setDirSize

public void setDirSize(int dirSize)

The number of compiled procedure directory entries (-D attribute)

Parameters:

dirSize - int

setGraphicalMode

public void setGraphicalMode(boolean graphMode)

Graphical mode on/off (call to _progres or prowin32)

Parameters:

graphMode - boolean

setIniFile

public void setIniFile(File iniFile)

Sets .ini file to use (-basekey INI -ininame xxx)

Parameters:

iniFile - File

setCpStream

public void setCpStream(String cpStream)

Stream code page (-cpstream attribute)

Parameters:

cpStream - String

setCpInternal

public void setCpInternal(String cpInternal)

Internal code page (-cpinternal attribute)

Parameters:

cpInternal - String

setInputChars

public void setInputChars(int inputChars)

The number of characters allowed in a single statement (-inp attribute)

Parameters:

inputChars - Integer

setCenturyYearOffset

public void setCenturyYearOffset(int centuryYearOffset)

Century year offset (-yy attribute)

Parameters:

centuryYearOffset - Integer

setToken

public void setToken(int token)

The number of tokens allowed in a 4GL statement (-tok attribute)

Parameters:

token - int

setMaximumMemory

public void setMaximumMemory(int maximumMemory)

The amount of memory allocated for r-code segments

Parameters:

maximumMemory - int

setStackSize

public void setStackSize(int stackSize)

The size of the stack in 1KB units.

Parameters:

stackSize - int

setTTBufferSize

public void setTTBufferSize(int ttBufferSize)

Buffer Size for Temporary Tables (-Bt attribute)

Parameters:

ttBufferSize - int

setMsgBufferSize

public void setMsgBufferSize(int msgBufSize)

Message buffer size (-Mm attribute)

Parameters:

msgBufSize - int

setDebugReady

public void setDebugReady(int debugReady)

Port number on which debugger should connect (-debugReady parameter)

Parameters:

debugReady - int

setTempDir

public void setTempDir(File tempDir)

Temporary directory for Progress runtime (-T parameter)

Parameters:

tempDir - File

setBaseDir

public void setBaseDir(File baseDir)

The directory in which the Progress runtime should be executed.

Parameters:

baseDir - File

setResultProperty

public void setResultProperty(String resultProperty)

Sets the name of a property in which the return valeur of the Progress procedure should be stored. Only of interest if failonerror=false.

Parameters:

resultProperty - name of property.

Since:

PCT 0.14

setFailOnError

public void setFailOnError(boolean failOnError)

getDbConnList

public List getDbConnList()

getRunParameters

public List getRunParameters()

getPropath

public org.apache.tools.ant.types.Path getPropath()

getDebugReady

public int getDebugReady()

isGraphMode

public boolean isGraphMode()

isDebugPCT

public boolean isDebugPCT()

isCompileUnderscore

public boolean isCompileUnderscore()

isBatchMode

public boolean isBatchMode()

getCpStream

public String getCpStream()

getCpInternal

public String getCpInternal()

getParameter

public String getParameter()

getNumsep

public String getNumsep()

getNumdec

public String getNumdec()

getInputChars

public int getInputChars()

getDirSize

public int getDirSize()

getCenturyYearOffset

public int getCenturyYearOffset()

getToken

public int getToken()

getMaximumMemory

public int getMaximumMemory()

getStackSize

public int getStackSize()

getTtBufferSize

public int getTtBufferSize()

getMessageBufferSize

public int getMessageBufferSize()

getIniFile

public File getIniFile()

getResultProperty

public String getResultProperty()

getTempDir

public File getTempDir()

getBaseDir

public File getBaseDir()

getProcedure

public String getProcedure()

setProcedure

public void setProcedure(String procedure)

getCmdLineParameters

protected List getCmdLineParameters()