com.viaoa.ds.cs

Class OADataSourceClient

java.lang.Object

com.viaoa.ds.OADataSource

com.viaoa.ds.cs.OADataSourceClient

All Implemented Interfaces:

OADataSourceInterface

public class OADataSourceClient
extends OADataSource

Uses OAClient to have all methods invoked on the OADataSource on OAServer.

For more information about this package, see documentation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASSIGN_ID internal value to work with OAClient
static int	COUNT internal value to work with OAClient
static int	COUNTPASSTHRU internal value to work with OAClient
static int	DELETE internal value to work with OAClient
static int	EXECUTE internal value to work with OAClient
static int	GET_ASSIGN_ID_ON_CREATE internal value to work with OAClient
static int	GET_PROPERTY
static int	INSERT internal value to work with OAClient
static int	INSERT_WO_REFERENCES
static int	IS_AVAILABLE internal value to work with OAClient
static int	IS_CLASS_SUPPORTED internal value to work with OAClient
static int	IT_HASNEXT internal value to work with OAClient
static int	IT_NEXT internal value to work with OAClient
static int	IT_REMOVE internal value to work with OAClient
static int	MAX_LENGTH internal value to work with OAClient
static int	SAVE internal value to work with OAClient
static int	SELECT internal value to work with OAClient
static int	SELECTPASSTHRU internal value to work with OAClient
static int	SUPPORTSSTORAGE internal value to work with OAClient
static int	UPDATE internal value to work with OAClient
static int	UPDATE_MANY2MANY_LINKS
static int	WILLCREATEPROPERTYVALUE internal value to work with OAClient

Fields inherited from class com.viaoa.ds.OADataSource

bAssignNumberOnCreate, bEnable, bLast, dataSourceChangeCnter, guid, name

Constructor Summary

Constructors

Constructor and Description
OADataSourceClient()
OADataSourceClient(Package packagex) Create new OADataSourceClient that uses OAClient to communicate with OADataSource on OAServer.

Method Summary

Modifier and Type	Method and Description
void	assignId(OAObject obj) Called by OAObject to initialize a new Object.
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 obj) Remove an Object from a DataSource.
Object	execute(String command) Execute a command on the dataSource.
boolean	getAssignIdOnCreate() Used to know if autonumber properties should be assigned on create or on save.
int	getMaxLength(Class c, String propertyName) Returns max length allowed for a property.
byte[]	getPropertyBlobValue(OAObject obj, String propertyName) Select BLOB (large byte[]) property
RemoteClientInterface	getRemoteClient()
void	insert(OAObject obj) Add/Insert a new Object into DataSource.
void	insertWithoutReferences(OAObject obj) Add/Insert a new Object into DataSource, without references (fkeys).
boolean	isAvailable() Used to know is datasoure is currently available.
boolean	isClassSupported(Class clazz, OAFilter filter) Used by static OADataSource to know if a registered OADataSource subclass supports a specific Class.
void	save(OAObject obj) Used to save an object to DataSource.
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.
void	setAssignIdOnCreate(boolean b) Used to know if autonumber properties should be assigned on create or on save.
void	setMaxLength(Class c, String propertyName, int length)
boolean	supportsStorage() does this dataSource support selecting/storing/deleting
void	update(OAObject obj, String[] includeProperties, String[] excludeProperties) Update an existing Object to DataSource.
void	updateMany2ManyLinks(OAObject masterObject, OAObject[] adds, OAObject[] removes, String propertyNameFromMaster) Used by dataSources to update special requirements for handling Many2Many relationships (ex:Link Table).
protected void	verifyConnection()
boolean	willCreatePropertyValue(OAObject object, String propertyName) Returns true if the dataSource will set the property value before saving.

Methods inherited from class com.viaoa.ds.OADataSource

close, closeAll, count, count, count, count, count, count, count, count, count, count, countPassthru, countPassthru, finalize, getAllowIdChange, getChangeCounter, getDataSource, getDataSource, getDataSources, getEnabled, getGuid, getInfo, getInfo, getName, getObject, getObject, getObject, getObject, getObject, getObject, getPosition, getSupportsPreCount, isClassSupported, removeFromList, reopen, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, selectPassthru, selectPassthru, selectPassthru, selectPassthru, selectPassthru, setEnabled, setGuid, setLast, setName, setPosition, toString, update

Methods inherited from class java.lang.Object

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

Field Detail

IS_AVAILABLE

public static final int IS_AVAILABLE

internal value to work with OAClient

See Also:

Constant Field Values

MAX_LENGTH

public static final int MAX_LENGTH

internal value to work with OAClient

See Also:

Constant Field Values

IS_CLASS_SUPPORTED

public static final int IS_CLASS_SUPPORTED

internal value to work with OAClient

See Also:

Constant Field Values

INSERT_WO_REFERENCES

public static final int INSERT_WO_REFERENCES

See Also:

Constant Field Values

UPDATE_MANY2MANY_LINKS

public static final int UPDATE_MANY2MANY_LINKS

See Also:

Constant Field Values

INSERT

public static final int INSERT

internal value to work with OAClient

See Also:

Constant Field Values

UPDATE

public static final int UPDATE

internal value to work with OAClient

See Also:

Constant Field Values

DELETE

public static final int DELETE

internal value to work with OAClient

See Also:

Constant Field Values

SAVE

public static final int SAVE

internal value to work with OAClient

See Also:

Constant Field Values

COUNT

public static final int COUNT

internal value to work with OAClient

See Also:

Constant Field Values

COUNTPASSTHRU

public static final int COUNTPASSTHRU

internal value to work with OAClient

See Also:

Constant Field Values

SUPPORTSSTORAGE

public static final int SUPPORTSSTORAGE

internal value to work with OAClient

See Also:

Constant Field Values

EXECUTE

public static final int EXECUTE

internal value to work with OAClient

See Also:

Constant Field Values

WILLCREATEPROPERTYVALUE

public static final int WILLCREATEPROPERTYVALUE

internal value to work with OAClient

See Also:

Constant Field Values

IT_HASNEXT

public static final int IT_HASNEXT

internal value to work with OAClient

See Also:

Constant Field Values

IT_NEXT

public static final int IT_NEXT

internal value to work with OAClient

See Also:

Constant Field Values

IT_REMOVE

public static final int IT_REMOVE

internal value to work with OAClient

See Also:

Constant Field Values

SELECT

public static final int SELECT

internal value to work with OAClient

See Also:

Constant Field Values

SELECTPASSTHRU

public static final int SELECTPASSTHRU

internal value to work with OAClient

See Also:

Constant Field Values

GET_ASSIGN_ID_ON_CREATE

public static final int GET_ASSIGN_ID_ON_CREATE

internal value to work with OAClient

See Also:

Constant Field Values

ASSIGN_ID

public static final int ASSIGN_ID

internal value to work with OAClient

See Also:

Constant Field Values

GET_PROPERTY

public static final int GET_PROPERTY

See Also:

Constant Field Values

Constructor Detail

OADataSourceClient

public OADataSourceClient(Package packagex)

Create new OADataSourceClient that uses OAClient to communicate with OADataSource on OAServer.

OADataSourceClient

public OADataSourceClient()

Method Detail

getRemoteClient

public RemoteClientInterface getRemoteClient()

setAssignIdOnCreate

public void setAssignIdOnCreate(boolean b)

Description copied from class: OADataSource

Used to know if autonumber properties should be assigned on create or on save.

Specified by:

setAssignIdOnCreate in interface OADataSourceInterface

Overrides:

setAssignIdOnCreate in class OADataSource

Parameters:

b - if true, assign autonumber property when object is created, else assign when object is saved.

getAssignIdOnCreate

public boolean getAssignIdOnCreate()

Description copied from class: OADataSource

Used to know if autonumber properties should be assigned on create or on save.

Specified by:

getAssignIdOnCreate in interface OADataSourceInterface

Overrides:

getAssignIdOnCreate in class OADataSource

isAvailable

public boolean isAvailable()

Description copied from class: OADataSource

Used to know is datasoure is currently available.

Specified by:

isAvailable in interface OADataSourceInterface

Overrides:

isAvailable in class OADataSource

getMaxLength

public int getMaxLength(Class c,
                        String propertyName)

Description copied from class: OADataSource

Returns max length allowed for a property. returns "-1" for any length.

Specified by:

getMaxLength in interface OADataSourceInterface

Overrides:

getMaxLength in class OADataSource

setMaxLength

public void setMaxLength(Class c,
                         String propertyName,
                         int length)

verifyConnection

protected void verifyConnection()

isClassSupported

public boolean isClassSupported(Class clazz,
                                OAFilter filter)

Description copied from class: OADataSource

Used by static OADataSource to know if a registered OADataSource subclass supports a specific Class.

Specified by:

isClassSupported in interface OADataSourceInterface

Specified by:

isClassSupported in class OADataSource

Parameters:

clazz - class

filter - used to query the datasource

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()

insert

public void insert(OAObject obj)

Description copied from class: OADataSource

Add/Insert a new Object into DataSource.

Called directly by OAObject.save()

Specified by:

insert in interface OADataSourceInterface

Specified by:

insert in class OADataSource

update

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

Description copied from class: OADataSource

Update an existing Object to DataSource.

Called directly by OAObject.save()

Specified by:

update in interface OADataSourceInterface

Specified by:

update in class OADataSource

save

public void save(OAObject obj)

Description copied from class: OADataSource

Used to save an object to DataSource.

If object is an OAObject, then update() or insert() will be called, else nothing is done.

Specified by:

save in interface OADataSourceInterface

Overrides:

save in class OADataSource

delete

public void delete(OAObject obj)

Description copied from class: OADataSource

Remove an Object from a DataSource.

Specified by:

delete in interface OADataSourceInterface

Specified by:

delete 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

supportsStorage

public boolean supportsStorage()

does this dataSource support selecting/storing/deleting

Specified by:

supportsStorage in interface OADataSourceInterface

Specified by:

supportsStorage in class OADataSource

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

execute

public Object execute(String command)

Description copied from class: OADataSource

Execute a command on the dataSource.

Specified by:

execute in interface OADataSourceInterface

Specified by:

execute in class OADataSource

Parameters:

command - DataSource native command.

assignId

public void assignId(OAObject obj)

Description copied from class: OADataSource

Called by OAObject to initialize a new Object.

Specified by:

assignId in interface OADataSourceInterface

Specified by:

assignId in class OADataSource

willCreatePropertyValue

public boolean willCreatePropertyValue(OAObject object,
                                       String propertyName)

Description copied from class: OADataSource

Returns true if the dataSource will set the property value before saving.

Specified by:

willCreatePropertyValue in interface OADataSourceInterface

Overrides:

willCreatePropertyValue 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

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