Callable

Class

DataFaucet 1.0 Beta

FRAMES

datafaucet.system
Class arschema

WEB-INF.cftags.component
        datafaucet.system.kernel
            datafaucet.system.duck
                datafaucet.system.broadcaster
                    datafaucet.system.transaction
                        datafaucet.system.arutilities
                            datafaucet.system.arschema

Direct Known Subclasses:: armanytomany

public class arschema
extends arutilities
extends arutilities

provides basic schema functionality for ActiveRecord objects

Constructor Summary
`init()`

Method Summary
`string`	`ActiveRecordLocale()`
`any`	`addTable(string table, [string column=''], [string references=''], [string select='*'])`
`private struct`	`fixModifiedColumns(struct insertData)` when column prefixes are occluded, this method adjusts property names back to column names during an insert or update
`string`	`getAuthor()`
`string`	`getColumn(string coltype)` returns the column set for a specific column type, i.e. created, modified or primary
`private string`	`getColumnNames()`
`private query`	`getColumns([string table='[runtime expression]'])`
`string`	`getCreatedDate()`
`string`	`getEditor()`
`private query`	`getExportedKeys()`
`private string`	`getForeignKey(string table)`
`private string`	`getIdentityColumn()`
`private query`	`getImportedKeys()`
`string`	`getInstallScript()` returns a SQL script for installing database entities
`string`	`getLastModified()`
`string`	`getObjectID()`
`private any`	`getPrimaryColumn()`
`private any`	`getPrimaryColumnType()`
`string`	`getPrimaryProperty()`
`private string`	`getRequiredColumns([string table='[runtime expression]'])`
`string`	`getSchema()`
`private any`	`getSchemaExport()`
`private any`	`getSchemaFromProperties()`
`private any`	`getSchemaTables()`
`string`	`getSequence()`
`string`	`getTable()`
`any`	`getTableArray()`
`string`	`getTimeZone()`
`any`	`getUninstallDDL()`
`string`	`getUpgradeScript()` returns a SQL script for installing new database entities and upgrading existing entities
`string`	`getUpgradeXML()`
`any`	`ignoreColumn(string colname)` indicates that a specific column should be ignored when performing a sql update
`boolean`	`install()`
`private string`	`newID()` creates a new unique identifier for the current object in the specified table
`private any`	`prepareInsert([struct insertdata='[runtime expression]'])`
`private string`	`prepareUpdate(struct insertdata)`
`any`	`removeIgnoredColumn(string colname)` removes an ignored column from the ignored columns list
`private void`	`removeIgnoredColumns(struct insertdata)`
`any`	`removeTable(string table)`
`any`	`setColumn(string coltype, string colname)` provides a method of setting several special-case column names for data management
`private void`	`setIdentityValue(numeric identityvalue)`
`private void`	`setIgnoredColumns()`
`private any`	`setMetaData()`
`private string`	`setNewID()`
`any`	`setObjectID(string objectid)`
`any`	`setSequence(string sequence)`
`any`	`setTable(string table)` sets the table to which this object belongs
`private any`	`throwTableError()`
`boolean`	`uninstall()`

Methods inherited from class datafaucet.system.arutilities
filterSQLStatement, getAllForeignKeys, getColumnMap, getDatasource, getDateProperties, getDefaultLocale, getDefaultTimezone, getForeignKeyValue, getFullTableName, getLocalization, getLock, getORMProperties, getPrimaryKeyData, getProperties, getProtectedColumns, getSQLInsert, getSQLStatement, getSelectStatement, getUTCLocale, hasDatasource, hasLocalization, lock, mapCollectionToProperties, nullForeignKeys, parseDates, queryToStruct, removeNullKeys, setDatasource, setLocalization, setNull, setORMProperties, simplify

Methods inherited from class datafaucet.system.arutilities

filterSQLStatement, getAllForeignKeys, getColumnMap, getDatasource, getDateProperties, getDefaultLocale, getDefaultTimezone, getForeignKeyValue, getFullTableName, getLocalization, getLock, getORMProperties, getPrimaryKeyData, getProperties, getProtectedColumns, getSQLInsert, getSQLStatement, getSelectStatement, getUTCLocale, hasDatasource, hasLocalization, lock, mapCollectionToProperties, nullForeignKeys, parseDates, queryToStruct, removeNullKeys, setDatasource, setLocalization, setNull, setORMProperties, simplify

Methods inherited from class datafaucet.system.transaction
`broadcastTransactionCommit, broadcastTransactionRollback, commitTransaction, execute, executeTransactedMethod, getCurrentIsolation, getTransactionDepth, openTransaction, rollbackTransaction, trace`

Methods inherited from class datafaucet.system.broadcaster
`Broadcast, addListener, getListeners`

Methods inherited from class datafaucet.system.duck
`addObserver, getObservers, getProperty, getPropertylist, getValue, identifyAccessorOrMutator, observe, onMissingMethod, raiseMissingMethodException, reset, setProperties, setProperty, setValue`

Methods inherited from class datafaucet.system.kernel
`arg, componentExists, getDataFaucet, getFaucetObject, getFile, getFileModified, getObject, getPlumbing, getTransaction, getTransactionManager, newTransaction, parseDate, setTransaction`

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init()

Method Detail

ActiveRecordLocale

public string ActiveRecordLocale()

addTable

public any addTable(string table, [string column=''], [string references=''], [string select='*'])

Parameters:: table - the name of the table to join to theq uery; column - the name of the target column in the joined table; references - the name of the source column in the table being adjoined; select - indicates columns in the join table to include when performing a read or update operation

fixModifiedColumns

private struct fixModifiedColumns(struct insertData)

when column prefixes are occluded, this method adjusts property names back to column names during an insert or update

getAuthor

public string getAuthor()

getColumn

public string getColumn(string coltype)

returns the column set for a specific column type, i.e. created, modified or primary

getColumnNames

private string getColumnNames()

getColumns

private query getColumns([string table='[runtime expression]'])

Parameters:: table

getCreatedDate

public string getCreatedDate()

getEditor

public string getEditor()

getExportedKeys

private query getExportedKeys()

getForeignKey

private string getForeignKey(string table)

Parameters:: table

getIdentityColumn

private string getIdentityColumn()

getImportedKeys

private query getImportedKeys()

getInstallScript

public string getInstallScript()

returns a SQL script for installing database entities

getLastModified

public string getLastModified()

getObjectID

public string getObjectID()

getPrimaryColumn

private any getPrimaryColumn()

getPrimaryColumnType

private any getPrimaryColumnType()

getPrimaryProperty

public string getPrimaryProperty()

getRequiredColumns

private string getRequiredColumns([string table='[runtime expression]'])

Parameters:: table

getSchema

public string getSchema()

getSchemaExport

private any getSchemaExport()

getSchemaFromProperties

private any getSchemaFromProperties()

getSchemaTables

private any getSchemaTables()

getSequence

public string getSequence()

getTable

public string getTable()

getTableArray

public any getTableArray()

getTimeZone

public string getTimeZone()

getUninstallDDL

public any getUninstallDDL()

getUpgradeScript

public string getUpgradeScript()

returns a SQL script for installing new database entities and upgrading existing entities

getUpgradeXML

public string getUpgradeXML()

ignoreColumn

public any ignoreColumn(string colname)

indicates that a specific column should be ignored when performing a sql update

install

public boolean install()

newID

private string newID()

creates a new unique identifier for the current object in the specified table

prepareInsert

private any prepareInsert([struct insertdata='[runtime expression]'])

Parameters:: insertdata

prepareUpdate

private string prepareUpdate(struct insertdata)

Parameters:: insertdata

removeIgnoredColumn

public any removeIgnoredColumn(string colname)

removes an ignored column from the ignored columns list

removeIgnoredColumns

private void removeIgnoredColumns(struct insertdata)

Parameters:: insertdata

removeTable

public any removeTable(string table)

Parameters:: table

setColumn

public any setColumn(string coltype, string colname)

provides a method of setting several special-case column names for data management

setIdentityValue

private void setIdentityValue(numeric identityvalue)

Parameters:: identityvalue

setIgnoredColumns

private void setIgnoredColumns()

setMetaData

private any setMetaData()

setNewID

private string setNewID()

setObjectID

public any setObjectID(string objectid)

Parameters:: objectid

setSequence

public any setSequence(string sequence)

Parameters:: sequence

setTable

public any setTable(string table)

sets the table to which this object belongs

throwTableError

private any throwTableError()

uninstall

public boolean uninstall()

Overview

Package