Callable

Class

Transfer version 1.1

FRAMES

transfer.com.sql
Class IDGenerator

WEB-INF.cftags.component
        transfer.com.sql.IDGenerator

public class IDGenerator
extends WEB-INF.cftags.component
extends WEB-INF.cftags.component

Generates IDs for a sequence

Constructor Summary
`init(numeric changeFactor, Datasource datasource, XMLFileReader configReader, Utility utility)` Constructor

Method Summary
`private boolean`	`checkHaveSequence(string name)` Checks to see if the sequence is in the collection
`private void`	`createNewSequence(Object object)` Creates a new sequence in the database if it doesn't exist
`private void`	`createSequenceTable()` Creates the database table for you
`private numeric`	`getChangeFactor()`
`private numeric`	`getCurrentIDFromSequence(string name)` gets the Current ID from the sequence
`private Datasource`	`getDatasource()`
`string`	`getGUID()` Returns a MS GUID, that is performant for indexing as per http://www.informit.com/articles/article.asp?p=25862
`private numeric`	`getIDFromSequence(Object object)` Gets an ID from a given sequence
`private numeric`	`getMaxIDFromSequence(string name)` gets the max ID from the sequence
`numeric`	`getNumericID(Object object)` Gets an numeric ID for a given object (synchronized)
`private struct`	`getSequenceCollection()`
`uuid`	`getUUID()` Gets a UUID as an ID
`private Utility`	`getUtility()`
`private void`	`increaseMaxIDForSequence(string name)` Increases the MaxID for a sequence
`private numeric`	`incrementCurrentID(string name)` retruns the currentID + 1 and increments it
`private void`	`initSequenceTable(XMLFileReader configReader)` creates the sequence table, if it is needed
`private void`	`restoreSequence(Object object)` restores a sequence from the DB
`private numeric`	`retrieveSequence(Object object, [boolean runOnce='false'], [boolean useBinding='true'])` Retrives the current ID for the sequence
`private void`	`setChangeFactor(numeric ChangeFactor)`
`private void`	`setCurrentIDFromSequence(string name, numeric currentID)` Sets the Max ID for a sequence
`private void`	`setDatasource(Datasource Datasource)`
`private void`	`setMaxIDFromSequence(string name, numeric maxID)` Sets the Max ID for a sequence
`private void`	`setSequenceCollection(struct SequenceCollection)`
`private void`	`setUtility(Utility Utility)`
`private any`	`throw(string type, string message, [string detail=''])` Throws an Exception
`private void`	`updateSequence(string name, numeric maxID)` Updates the sequence in the db

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(numeric changeFactor, Datasource datasource, XMLFileReader configReader, Utility utility)

Constructor

Parameters:: changeFactor - How many IDs to keep resident; datasource - Datasource for the applicaiton; configReader - The XML Reader for the config file; utility - The utility class

Method Detail

checkHaveSequence

private boolean checkHaveSequence(string name)

Checks to see if the sequence is in the collection

createNewSequence

private void createNewSequence(Object object)

Creates a new sequence in the database if it doesn't exist

createSequenceTable

private void createSequenceTable()

Creates the database table for you

getChangeFactor

private numeric getChangeFactor()

getCurrentIDFromSequence

private numeric getCurrentIDFromSequence(string name)

gets the Current ID from the sequence

getDatasource

private Datasource getDatasource()

getGUID

public string getGUID()

Returns a MS GUID, that is performant for indexing as per http://www.informit.com/articles/article.asp?p=25862

getIDFromSequence

private numeric getIDFromSequence(Object object)

Gets an ID from a given sequence

getMaxIDFromSequence

private numeric getMaxIDFromSequence(string name)

gets the max ID from the sequence

getNumericID

public numeric getNumericID(Object object)

Gets an numeric ID for a given object (synchronized)

getSequenceCollection

private struct getSequenceCollection()

getUUID

public uuid getUUID()

Gets a UUID as an ID

getUtility

private Utility getUtility()

increaseMaxIDForSequence

private void increaseMaxIDForSequence(string name)

Increases the MaxID for a sequence

incrementCurrentID

private numeric incrementCurrentID(string name)

retruns the currentID + 1 and increments it

initSequenceTable

private void initSequenceTable(XMLFileReader configReader)

creates the sequence table, if it is needed

restoreSequence

private void restoreSequence(Object object)

restores a sequence from the DB

retrieveSequence

private numeric retrieveSequence(Object object, [boolean runOnce='false'], [boolean useBinding='true'])

Retrives the current ID for the sequence

setChangeFactor

private void setChangeFactor(numeric ChangeFactor)

Parameters:: ChangeFactor

setCurrentIDFromSequence

private void setCurrentIDFromSequence(string name, numeric currentID)

Sets the Max ID for a sequence

setDatasource

private void setDatasource(Datasource Datasource)

Parameters:: Datasource

setMaxIDFromSequence

private void setMaxIDFromSequence(string name, numeric maxID)

Sets the Max ID for a sequence

setSequenceCollection

private void setSequenceCollection(struct SequenceCollection)

Parameters:: SequenceCollection

setUtility

private void setUtility(Utility Utility)

Parameters:: Utility

throw

private any throw(string type, string message, [string detail=''])

Throws an Exception

updateSequence

private void updateSequence(string name, numeric maxID)

Updates the sequence in the db

Overview

Package