tasks/ext/creole/CreoleTask.php
inherited
Classes
\CreoleTask
Handles Creole configuration needed by SQL type tasks.
- Parent(s)
- \Task < \ProjectComponent
- Children
- \CreoleSQLExecTask
- Author
- Hans Lellelid
- Author
- Nick Chalko
- Author
- Jeff Martin
- Author
- Michael McCallum
- Author
- Tim Stephenson
- Version
- $Revision: 526 $
Properties
$autocommit= 'false'
Autocommit flag. Default value is false
falseDetails- Type
- n/a
$caching= 'true'
trueDetails- Type
- n/a
$driver= ''
[optional] Classpath to Creole driver to use.
- Type
- n/a
- $driver
string
$loaderMap= 'array()'
Used for caching loaders / driver. This is to avoid getting an OutOfMemoryError when calling this task multiple times in a row.
NOT IMPLEMENTED YET
array()Details- Type
- n/a
$password= ''
Password
- Type
- n/a
$rdbms= ''
RDBMS Product needed for this SQL.
- Type
- n/a
$url= ''
DB url.
- Type
- n/a
$userId= ''
User name.
- Type
- n/a
Methods
getConnection(
)
:
\ConnectionCreates a new Connection as using the driver, url, userid and password specified.
The calling method is responsible for closing the connection.
| Type | Description |
|---|---|
| \Connection | the newly created connection. |
| Exception | Description |
|---|---|
| \BuildException | if the UserId/Password/Url is not set or there is no suitable driver or the driver fails to load. |
getDescription(
)
:
voidgetLoaderMap(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetPassword(
)
:
\ReturnsGets the password.
| Type | Description |
|---|---|
| \Returns | a String |
getProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidgetUrl(
)
:
\ReturnsGets the url.
| Type | Description |
|---|---|
| \Returns | a String |
getUserId(
)
:
\ReturnsGets the userId.
| Type | Description |
|---|---|
| \Returns | a String |
init(
)
:
voidInitialize CreoleTask.
This method includes any necessary Creole libraries and triggers appropriate error if they cannot be found. This is not done in header because we may want this class to be loaded w/o triggering an error.
isAutocommit(
)
:
\ReturnsGets the autocommit.
| Type | Description |
|---|---|
| \Returns | a boolean |
isCaching(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
log(
)
:
voidmain(
)
:
voidmaybeConfigure(
)
:
voidperform(
)
:
voidsetAutocommit(
\autocommit $autocommit
)
:
voidAuto commit flag for database connection; optional, default false.
| Name | Type | Description |
|---|---|---|
| $autocommit | \autocommit | The autocommit to set |
setCaching(
$enable
)
:
voidCaching loaders / driver. This is to avoid getting an OutOfMemoryError when calling this task multiple times in a row; default: true
| Name | Type | Description |
|---|---|---|
| $enable |
setDescription(
)
:
voidsetDriver(
string $driver
)
:
voidSet the Creole driver to be used.
| Name | Type | Description |
|---|---|---|
| $driver | string | driver class name |
setLocation(
)
:
voidsetOwningTarget(
)
:
voidsetPassword(
\password $password
)
:
voidSets the password; required.
| Name | Type | Description |
|---|---|---|
| $password | \password | The password to set |
setProject(
)
:
voidsetRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
voidsetUrl(
\url $url
)
:
voidSets the database connection URL; required.
| Name | Type | Description |
|---|---|---|
| $url | \url | The url to set |
setUserid(
\userId $userId
)
:
voidSet the user name for the connection; required.
| Name | Type | Description |
|---|---|---|
| $userId | \userId | The userId to set |
setVersion(
\version $version
)
:
voidSets the version string, execute task only if rdbms version match; optional.
| Name | Type | Description |
|---|---|---|
| $version | \version | The version to set |