com.viaoa.datasource.autonumber

Class OADataSourceAuto

java.lang.Object

com.viaoa.datasource.OADataSource

com.viaoa.datasource.autonumber.OADataSourceAuto

All Implemented Interfaces:

OADataSourceInterface

Direct Known Subclasses:

OADataSourceObjectCache

public class OADataSourceAuto
extends OADataSource

OADataSource that does not support selects or storage. Can be used to act as a "dummy" datasource. It can assign autoNumbers for new objects that have object Id properties that are numbers and not initialized. (see setAssignIdOnCreate(true))

For more information about this package, see documentation.

Field Summary

Fields inherited from class com.viaoa.datasource.OADataSource

bAssignNumberOnCreate, bEnabled, bLast, dataSourceChangeCnter, guid, name

Constructor Summary

Constructors

Constructor and Description
OADataSourceAuto()
OADataSourceAuto(boolean bMakeLastDataSource)
OADataSourceAuto(boolean bRegister, boolean bMakeLastDataSource)
OADataSourceAuto(Hub hubNextNumber)
OADataSourceAuto(Hub hubNextNumber, boolean bRegister, boolean bMakeLastDataSource) Hub hubNextNumber must include a separate NextNumber2 object for each class that needs to have a seqId assigned to its objectId property.

Method Summary

Modifier and Type	Method and Description
void	assignId(OAObject oaObj) Set any objectId properties that are of class Number (or primitive equiv) and whose value is "0" to the value in the NextNumber object found in getHub().
int	count(Class selectClass, String queryWhere, Object[] params, OAObject whereObject, String propertyFromWhereObject, String extraWhere, int max) Perform a count on the DataSource using a query.
int	countPassthru(Class selectClass, String queryWhere, int max) Performs a count using native query language for DataSource.
void	delete(OAObject object) Does not support data storage.
Object	execute(String command) Overwritten to always return null.
static Hub<NextNumber>	getGlobalNextNumber()
Hub	getHub() Hub used to store NextNumber2 objects used for assigning new property ids.
byte[]	getPropertyBlobValue(OAObject obj, String propertyName) Select BLOB (large byte[]) property
boolean	getSupportAllClasses() Used to know if this DataSource should respond true to all request for service for Classes.
void	insert(OAObject object) Overwritten to only initialize object.
void	insertWithoutReferences(OAObject obj) Add/Insert a new Object into DataSource, without references (fkeys).
boolean	isClassSupported(Class clazz, OAFilter filter) Returns true if NextNumber2 with Class name as Id is in HubNextNumber or if getSupportAllClasses is true.
OADataSourceIterator	select(Class selectClass, String queryWhere, Object[] params, String queryOrder, OAObject whereObject, String propertyFromWhereObject, String extraWhere, int max, OAFilter filter, boolean bDirty) Perform a query to retrieve objects from DataSource.
OADataSourceIterator	selectPassthru(Class selectClass, String queryWhere, String queryOrder, int max, OAFilter filter, boolean bDirty) Performs a select using native query language for DataSource.
static void	setGlobalNextNumber(Hub hubNextNumber)
void	setHub(Hub hubNextNumber) Hub used to store NextNumber2 objects used for assigning new property ids.
void	setSupportAllClasses(boolean b) Used to know if this DataSource should respond true to all request for service for Classes.
boolean	supportsStorage() Overwritten to return false.
void	update(OAObject object, String[] includeProperties, String[] excludeProperties) Overwritten to do nothing.
void	updateMany2ManyLinks(OAObject masterObject, OAObject[] adds, OAObject[] removes, String propertyNameFromMaster) Used by dataSources to update special requirements for handling Many2Many relationships (ex:Link Table).
boolean	willCreatePropertyValue(OAObject oaObj, String propertyName) Returns true if propertyName is an Object Id property.

Methods inherited from class com.viaoa.datasource.OADataSource

close, closeAll, count, count, count, count, count, count, count, count, count, count, countPassthru, countPassthru, deleteAll, finalize, getAllowIdChange, getAssignIdOnCreate, getChangeCounter, getDataSource, getDataSource, getDataSources, getEnabled, getGuid, getIgnoreWrites, getInfo, getInfo, getMaxLength, getName, getObject, getObject, getObject, getObject, getObject, getObject, getPosition, getReadOnly, getSupportsPreCount, isAllowingBatch, isAvailable, isClassSupported, isInTransaction, removeFromList, reopen, save, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, selectPassthru, selectPassthru, selectPassthru, selectPassthru, selectPassthru, setAssignIdOnCreate, setEnabled, setGuid, setIgnoreWrites, setLast, setName, setPosition, setReadOnly, toString, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.viaoa.datasource.OADataSourceInterface

backup, checkForCorruption, compress, isClient, restore

Constructor Detail

OADataSourceAuto

public OADataSourceAuto()

OADataSourceAuto

public OADataSourceAuto(boolean bRegister,
                        boolean bMakeLastDataSource)

OADataSourceAuto

public OADataSourceAuto(boolean bMakeLastDataSource)

OADataSourceAuto

public OADataSourceAuto(Hub hubNextNumber)

OADataSourceAuto

public OADataSourceAuto(Hub hubNextNumber,
                        boolean bRegister,
                        boolean bMakeLastDataSource)

Hub hubNextNumber must include a separate NextNumber2 object for each class that needs to have a seqId assigned to its objectId property. The objects in hubNextNumber also need to be saved (OAObject.save() or hubNextNumber.saveAll()). The objectId property will be set when the object is created (OAObject constructor)

Method Detail

setGlobalNextNumber

public static void setGlobalNextNumber(Hub hubNextNumber)

getGlobalNextNumber

public static Hub<NextNumber> getGlobalNextNumber()

setHub

public void setHub(Hub hubNextNumber)

Hub used to store NextNumber2 objects used for assigning new property ids.

getHub

public Hub getHub()

Hub used to store NextNumber2 objects used for assigning new property ids.

supportsStorage

public boolean supportsStorage()

Overwritten to return false.

Specified by:

supportsStorage in interface OADataSourceInterface

Specified by:

supportsStorage in class OADataSource

getSupportAllClasses

public boolean getSupportAllClasses()

Used to know if this DataSource should respond true to all request for service for Classes. This can be used to act as a catch all for DataSource requests.

setSupportAllClasses

public void setSupportAllClasses(boolean b)

Used to know if this DataSource should respond true to all request for service for Classes. This can be used to act as a catch all for DataSource requests.

isClassSupported

public boolean isClassSupported(Class clazz,
                                OAFilter filter)

Returns true if NextNumber2 with Class name as Id is in HubNextNumber or if getSupportAllClasses is true.

Specified by:

isClassSupported in interface OADataSourceInterface

Specified by:

isClassSupported in class OADataSource

Parameters:

clazz - class

filter - used to query the datasource

See Also:

getHub(), setSupportAllClasses(boolean)

assignId

public void assignId(OAObject oaObj)

Set any objectId properties that are of class Number (or primitive equiv) and whose value is "0" to the value in the NextNumber object found in getHub(). This will also call OAObject.save() if Auto Save is true.

Specified by:

assignId in interface OADataSourceInterface

Specified by:

assignId in class OADataSource

updateMany2ManyLinks

public void updateMany2ManyLinks(OAObject masterObject,
                                 OAObject[] adds,
                                 OAObject[] removes,
                                 String propertyNameFromMaster)

Description copied from class: OADataSource

Used by dataSources to update special requirements for handling Many2Many relationships (ex:Link Table).

Uses the hub.masterObject, Hub.getRemovedObjects(), Hub.getAddedObjects() to find out which objects were added or removed.
This is called by OAObject.cascadeSave/Delete methods

Specified by:

updateMany2ManyLinks in interface OADataSourceInterface

Specified by:

updateMany2ManyLinks in class OADataSource

willCreatePropertyValue

public boolean willCreatePropertyValue(OAObject oaObj,
                                       String propertyName)

Returns true if propertyName is an Object Id property.

Specified by:

willCreatePropertyValue in interface OADataSourceInterface

Overrides:

willCreatePropertyValue in class OADataSource

insert

public void insert(OAObject object)

Overwritten to only initialize object. OADataSourceNextNumber Does not support data storage.

Specified by:

insert in interface OADataSourceInterface

Specified by:

insert in class OADataSource

insertWithoutReferences

public void insertWithoutReferences(OAObject obj)

Description copied from class: OADataSource

Add/Insert a new Object into DataSource, without references (fkeys).

Called directly by OAObject.saveWithoutReferences() to save a reference while saving another Object.

Specified by:

insertWithoutReferences in interface OADataSourceInterface

Specified by:

insertWithoutReferences in class OADataSource

See Also:

OAObject.save()

update

public void update(OAObject object,
                   String[] includeProperties,
                   String[] excludeProperties)

Overwritten to do nothing. OADataSourceNextNumber Does not support data storage.

Specified by:

update in interface OADataSourceInterface

Specified by:

update in class OADataSource

delete

public void delete(OAObject object)

Does not support data storage.

Specified by:

delete in interface OADataSourceInterface

Specified by:

delete in class OADataSource

execute

public Object execute(String command)

Overwritten to always return null. OADataSourceNextNumber Does not support data storage.

Specified by:

execute in interface OADataSourceInterface

Specified by:

execute in class OADataSource

Parameters:

command - DataSource native command.

getPropertyBlobValue

public byte[] getPropertyBlobValue(OAObject obj,
                                   String propertyName)

Description copied from class: OADataSource

Select BLOB (large byte[]) property

Specified by:

getPropertyBlobValue in interface OADataSourceInterface

Specified by:

getPropertyBlobValue in class OADataSource

count

public int count(Class selectClass,
                 String queryWhere,
                 Object[] params,
                 OAObject whereObject,
                 String propertyFromWhereObject,
                 String extraWhere,
                 int max)

Description copied from class: OADataSource

Perform a count on the DataSource using a query.

Specified by:

count in interface OADataSourceInterface

Specified by:

count in class OADataSource

Parameters:

selectClass - Class to perform query on

queryWhere - query using property paths based on Object structure.

See Also:

OASelect

countPassthru

public int countPassthru(Class selectClass,
                         String queryWhere,
                         int max)

Description copied from class: OADataSource

Performs a count using native query language for DataSource.

Specified by:

countPassthru in interface OADataSourceInterface

Specified by:

countPassthru in class OADataSource

queryWhere - query based on DataSource structure.

See Also:

OASelect

select

public OADataSourceIterator select(Class selectClass,
                                   String queryWhere,
                                   Object[] params,
                                   String queryOrder,
                                   OAObject whereObject,
                                   String propertyFromWhereObject,
                                   String extraWhere,
                                   int max,
                                   OAFilter filter,
                                   boolean bDirty)

Description copied from class: OADataSource

Perform a query to retrieve objects from DataSource.

See OASelect for complete description on selects/queriess.

Specified by:

select in interface OADataSourceInterface

Specified by:

select in class OADataSource

Parameters:

selectClass - Class of object to create and return

queryWhere - query String using property paths based on Object structure. DataSource

params - list of values to replace '?' in queryWhere clause.

queryOrder - sort order

whereObject - master object to select from.

extraWhere - added to the query.

filter - the datasource filter, used if the ds does not support queries (ex: sql) will convert query to native query language of the datasoure.

bDirty - true if objects should be fully populated, even if they are already loaded (in cache, etc).

Returns:

OADataSourceIterator that is used to return objects of type selectClass

See Also:

OASelect

selectPassthru

public OADataSourceIterator selectPassthru(Class selectClass,
                                           String queryWhere,
                                           String queryOrder,
                                           int max,
                                           OAFilter filter,
                                           boolean bDirty)

Description copied from class: OADataSource

Performs a select using native query language for DataSource.

Specified by:

selectPassthru in interface OADataSourceInterface

Specified by:

selectPassthru in class OADataSource

Parameters:

selectClass - Class of object to create and return

queryWhere - query based on DataSource structure.

Returns:

OADataSourceIterator that is used to return objects of type selectClass

See Also:

OASelect