|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.intersys.classes.CacheGeneric
com.intersys.classes.CacheRootObject
com.intersys.classes.RegisteredObject
com.intersys.classes.SerialObject
Sample.Address
Field Summary |
Fields inherited from class com.intersys.classes.CacheRootObject |
mInternal |
Constructor Summary | |
Address(CacheObject ref)
NB: DO NOT USE IN APPLICATION(!!!). |
|
Address(Database db)
Creates a new instance of object "Address" in Cache database and corresponding object of class Address . |
|
Address(Database db,
java.lang.String initstr)
|
Method Summary | |
static RegisteredObject |
_open(Database db,
Oid oid)
Runs method %Open in Cache to open an object
from Cache database and creates corresponding object of class
Address . |
static RegisteredObject |
_open(Database db,
Oid oid,
int concurrency)
Runs method %Open in Cache to open an object
from Cache database and creates corresponding object of class
Address . |
static void |
checkAllFieldsValid(Database db)
Verifies that all fields from Cache class are exposed with accessor methods in Java class and that values for indexes in zObjVal are the same as in Cache. |
static void |
checkAllMethods(Database db)
Verifies that all fields from Cache class are exposed with accessor methods in Java class and that values for indexes in zObjVal are the same as in Cache. |
static void |
checkCityValid(Database db)
Verifies that indexes for property City in
zObjVal are the same as in Cache. |
static void |
checkStateValid(Database db)
Verifies that indexes for property State in
zObjVal are the same as in Cache. |
static void |
checkStreetValid(Database db)
Verifies that indexes for property Street in
zObjVal are the same as in Cache. |
static void |
checkZipValid(Database db)
Verifies that indexes for property Zip in
zObjVal are the same as in Cache. |
static RegisteredObject |
createClientObject(Database db)
|
CacheClass |
getCacheClass()
Allows access metadata information about type of this object in Cache database. |
static java.lang.String |
getCacheClassName()
Returns class name of the class Address as it is in Cache Database. |
java.lang.String |
getCity()
Returns value of property City . |
java.lang.String |
getState()
Returns value of property State . |
java.lang.String |
getStreet()
Returns value of property Street . |
java.lang.String |
getZip()
Returns value of property Zip . |
static java.lang.String |
LogicalToOdbc(Database db)
Runs method LogicalToOdbc in Cache. |
static java.lang.String |
LogicalToOdbc(Database db,
java.lang.String val)
Runs method LogicalToOdbc in Cache. |
static java.lang.String |
OdbcToLogical(Database db)
Runs method OdbcToLogical in Cache. |
static java.lang.String |
OdbcToLogical(Database db,
java.lang.String val)
Runs method OdbcToLogical in Cache. |
void |
OnPopulate()
Runs method OnPopulate in Cache. |
static SerialObject |
open(Database db,
byte[] serialState)
|
static java.lang.Integer |
Populate(Database db)
Runs method Populate in Cache. |
static java.lang.Integer |
Populate(Database db,
java.lang.Integer count)
Runs method Populate in Cache. |
static java.lang.Integer |
Populate(Database db,
java.lang.Integer count,
java.lang.Integer verbose)
Runs method Populate in Cache. |
static java.lang.Integer |
Populate(Database db,
java.lang.Integer count,
java.lang.Integer verbose,
java.lang.Integer DeferIndices)
Runs method Populate in Cache. |
static java.lang.Integer |
Populate(Database db,
java.lang.Integer count,
java.lang.Integer verbose,
java.lang.Integer DeferIndices,
IntegerHolder objects)
Runs method Populate in Cache. |
static java.lang.String |
PopulateSerial(Database db)
Runs method PopulateSerial in Cache. |
void |
setCity(java.lang.String value)
Sets new value for City . |
void |
setState(java.lang.String value)
Sets new value for State . |
void |
setStreet(java.lang.String value)
Sets new value for Street . |
void |
setZip(java.lang.String value)
Sets new value for Zip . |
static java.lang.String |
sys_ClassName(Database db,
java.lang.Boolean fullname)
Runs method sys_ClassName in Cache. |
static java.lang.Integer |
sys_Extends(Database db,
java.lang.String isclass)
Runs method sys_Extends in Cache. |
static java.lang.String |
sys_GetParameter(Database db)
Runs method sys_GetParameter in Cache. |
static java.lang.String |
sys_GetParameter(Database db,
java.lang.String paramname)
Runs method sys_GetParameter in Cache. |
static java.lang.Integer |
sys_IsA(Database db,
java.lang.String isclass)
Runs method sys_IsA in Cache. |
static java.lang.String |
sys_PackageName(Database db)
Runs method sys_PackageName in Cache. |
Methods inherited from class com.intersys.classes.SerialObject |
_getSwizzleObject, _getSwizzleObject, _getSwizzleObject, _logicalToOdbc, _logicalToOdbc, _odbcToLogical, _odbcToLogical, getOid, openOnServer, serialize, serialize |
Methods inherited from class com.intersys.classes.RegisteredObject |
_className, _className, _constructClone, _constructClone, _constructClone, _isA, _isModified, _normalizeObject, _packageName, _validateObject, _validateObject, constructClone, constructClone, getZRef |
Methods inherited from class com.intersys.classes.CacheRootObject |
_close, castTo, changeInternal, equals, finalize, getDatabase, getField, getOref, getProxy, getString, getUserData, hashCode, release, releaseInternal, setUserData, toString |
Methods inherited from class com.intersys.classes.CacheGeneric |
checkAllFieldsValid, checkAllMethods, checkFieldsLimited, checkZobjValid, reset |
Methods inherited from class java.lang.Object |
clone, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Address(CacheObject ref) throws CacheException
NB: DO NOT USE IN APPLICATION(!!!).
Use Address._open
instead!
Used to construct a Java object, corresponding to existing object in Cache database.
_open(com.intersys.objects.Database, com.intersys.objects.Oid)
public Address(Database db, java.lang.String initstr) throws CacheException
public Address(Database db) throws CacheException
Address
.
db
- Database
object used for connection with
Cache database.
CacheException
- in case of error._open(com.intersys.objects.Database, com.intersys.objects.Oid)
Method Detail |
public static RegisteredObject createClientObject(Database db) throws CacheException
CacheException
public static SerialObject open(Database db, byte[] serialState) throws CacheException
CacheException
public static RegisteredObject _open(Database db, Oid oid) throws CacheException
%Open
in Cache to open an object
from Cache database and creates corresponding object of class
Address
.
db
- Database
object used for connection with
Cache database.oid
- Object ID as specified in Cache. represented as
Oid
.
RegisteredObject
, corresponding to opened
object. This object may be of Address
or of
any of its subclasses. Cast to Address
is
guaranteed to pass without ClassCastException
exception.
CacheException
- in case of error.ClassCastException
,
_open(com.intersys.objects.Database, com.intersys.objects.Oid)
,
Address(com.intersys.objects.Database)
public static RegisteredObject _open(Database db, Oid oid, int concurrency) throws CacheException
%Open
in Cache to open an object
from Cache database and creates corresponding object of class
Address
.
db
- Database
object used for connection with
Cache database.oid
- Object ID as specified in Cache. represented as
Oid
.concurrency
- Concurrency level. represented as
Concurrency
.
Here are concurrency values, see Object Concurrency Options in your on-line Cache' documentation for more information.
RegisteredObject
, corresponding to opened
object. This object may be of Address
or of
any of its subclasses. Cast to Address
is
guaranteed to pass without ClassCastException
exception.
CacheException
- in case of error.0 | No locking, no locks are used |
1 | Atomic |
2 | Shared |
3 | Shared/Retained |
4 | Exclusive |
ClassCastException
,
_open(com.intersys.objects.Database, com.intersys.objects.Oid)
,
Address(com.intersys.objects.Database)
public static java.lang.String getCacheClassName()
getCacheClass().geName()
to get the class name
for specific object.
String
getCacheClass()
,
CacheClass.getName()
public CacheClass getCacheClass() throws CacheException
CacheClass
object for this object type.
CacheException
public static void checkAllFieldsValid(Database db) throws CacheException
But if there is any inconsistency in zObjVal indexes this is fatal and class can not work correctly and must be regenerated
db
- Database used for connection. Note that if you are
using multiple databases the class can be consistent with one
and inconsistent with another.
InvalidClassException
- if any inconsistency is found.
CacheException
- if any error occurred during
verification, e.g. communication error with Database.InvalidPropertyException
public static void checkAllMethods(Database db) throws CacheException
But if there is any inconsistency in zObjVal indexes this is fatal and class can not work correctly and must be regenerated
db
- Database used for connection. Note that if you are
using multiple databases the class can be consistent with one
and inconsistent with another.
InvalidClassException
- if any inconsistency is found.
CacheException
- if any error occurred during
verification, e.g. communication error with Database.InvalidPropertyException
public static void checkCityValid(Database db) throws CacheException
City
in
zObjVal are the same as in Cache. It does not return anything
but it throws an exception in case of inconsistency.
Please note, that if there is any inconsistency in zObjVal indexes this is fatal and class can not work correctly and must be regenerated.
db
- Database used for connection. Note that if you are
using multiple databases the class can be consistent with one
and inconsistent with another.
InvalidClassException
- if any inconsistency is found.
CacheException
- if any error occurred during
verification, e.g. communication error with Database.checkAllFieldsValid(com.intersys.objects.Database)
public java.lang.String getCity() throws CacheException
City
.
Description: The city name.
City
represented as
java.lang.String
CacheException
- if any error occurred during value retrieval.public void setCity(java.lang.String value) throws CacheException
City
.
Description: The city name.
value
- new value to be set represented as
java.lang.String
.
CacheException
- if any error occurred during value setting.public static void checkStateValid(Database db) throws CacheException
State
in
zObjVal are the same as in Cache. It does not return anything
but it throws an exception in case of inconsistency.
Please note, that if there is any inconsistency in zObjVal indexes this is fatal and class can not work correctly and must be regenerated.
db
- Database used for connection. Note that if you are
using multiple databases the class can be consistent with one
and inconsistent with another.
InvalidClassException
- if any inconsistency is found.
CacheException
- if any error occurred during
verification, e.g. communication error with Database.checkAllFieldsValid(com.intersys.objects.Database)
public java.lang.String getState() throws CacheException
State
.
Description: The 2-letter state abbreviation.
State
represented as
java.lang.String
CacheException
- if any error occurred during value retrieval.public void setState(java.lang.String value) throws CacheException
State
.
Description: The 2-letter state abbreviation.
value
- new value to be set represented as
java.lang.String
.
CacheException
- if any error occurred during value setting.public static void checkStreetValid(Database db) throws CacheException
Street
in
zObjVal are the same as in Cache. It does not return anything
but it throws an exception in case of inconsistency.
Please note, that if there is any inconsistency in zObjVal indexes this is fatal and class can not work correctly and must be regenerated.
db
- Database used for connection. Note that if you are
using multiple databases the class can be consistent with one
and inconsistent with another.
InvalidClassException
- if any inconsistency is found.
CacheException
- if any error occurred during
verification, e.g. communication error with Database.checkAllFieldsValid(com.intersys.objects.Database)
public java.lang.String getStreet() throws CacheException
Street
.
Description: The street address.
Street
represented as
java.lang.String
CacheException
- if any error occurred during value retrieval.public void setStreet(java.lang.String value) throws CacheException
Street
.
Description: The street address.
value
- new value to be set represented as
java.lang.String
.
CacheException
- if any error occurred during value setting.public static void checkZipValid(Database db) throws CacheException
Zip
in
zObjVal are the same as in Cache. It does not return anything
but it throws an exception in case of inconsistency.
Please note, that if there is any inconsistency in zObjVal indexes this is fatal and class can not work correctly and must be regenerated.
db
- Database used for connection. Note that if you are
using multiple databases the class can be consistent with one
and inconsistent with another.
InvalidClassException
- if any inconsistency is found.
CacheException
- if any error occurred during
verification, e.g. communication error with Database.checkAllFieldsValid(com.intersys.objects.Database)
public java.lang.String getZip() throws CacheException
Zip
.
Description: The 5-digit U.S. Zone Improvement Plan (ZIP) code.
Zip
represented as
java.lang.String
CacheException
- if any error occurred during value retrieval.public void setZip(java.lang.String value) throws CacheException
Zip
.
Description: The 5-digit U.S. Zone Improvement Plan (ZIP) code.
value
- new value to be set represented as
java.lang.String
.
CacheException
- if any error occurred during value setting.public static java.lang.String sys_ClassName(Database db, java.lang.Boolean fullname) throws CacheException
Runs method sys_ClassName in Cache.
Description: Returns the object's class name. The fullname determines how the class name is represented. If it is 1 then it returns the full class name including any package qualifier. If it is 0 (the default) then it returns the name of the class without the package, this is mainly for backward compatibility with the pre-package behaviour of %ClassName.
db
- represented as Databasefullname
- represented as java.lang.Boolean
CacheException
- if any error occured while running the method.public static java.lang.Integer sys_Extends(Database db, java.lang.String isclass) throws CacheException
Runs method sys_Extends in Cache.
Description: Returns true (1) if this class is inherited either via primary or secondary inheritance from 'isclass'.
db
- represented as Databaseisclass
- represented as java.lang.String
CacheException
- if any error occured while running the method.public static java.lang.String sys_GetParameter(Database db) throws CacheException
Runs method sys_GetParameter in Cache.
Description: This method returns the value of a parameter at runtime
db
- represented as Database
default argument paramname set to ""
CacheException
- if any error occured while running the method.sys_GetParameter(Database,java.lang.String)
,
Method %GetParameterpublic static java.lang.String sys_GetParameter(Database db, java.lang.String paramname) throws CacheException
Runs method sys_GetParameter in Cache.
Description: This method returns the value of a parameter at runtime
db
- represented as Databaseparamname
- represented as java.lang.String
CacheException
- if any error occured while running the method.public static java.lang.Integer sys_IsA(Database db, java.lang.String isclass) throws CacheException
Runs method sys_IsA in Cache.
Description: Returns true (1) if instances of this class are also instances of the isclass parameter. That is 'isclass' is a primary superclass of this object.
db
- represented as Databaseisclass
- represented as java.lang.String
CacheException
- if any error occured while running the method.public static java.lang.String sys_PackageName(Database db) throws CacheException
Runs method sys_PackageName in Cache.
Description: Returns the object's package name.
db
- represented as Database
CacheException
- if any error occured while running the method.public static java.lang.String LogicalToOdbc(Database db) throws CacheException
Runs method LogicalToOdbc in Cache.
db
- represented as Database
default argument val set to ""
CacheException
- if any error occured while running the method.LogicalToOdbc(Database,java.lang.String)
,
Method LogicalToOdbcpublic static java.lang.String LogicalToOdbc(Database db, java.lang.String val) throws CacheException
Runs method LogicalToOdbc in Cache.
db
- represented as Databaseval
- represented as java.lang.String
CacheException
- if any error occured while running the method.public static java.lang.String OdbcToLogical(Database db) throws CacheException
Runs method OdbcToLogical in Cache.
db
- represented as Database
default argument val set to ""
CacheException
- if any error occured while running the method.OdbcToLogical(Database,java.lang.String)
,
Method OdbcToLogicalpublic static java.lang.String OdbcToLogical(Database db, java.lang.String val) throws CacheException
Runs method OdbcToLogical in Cache.
db
- represented as Databaseval
- represented as java.lang.String
CacheException
- if any error occured while running the method.public void OnPopulate() throws CacheException
Runs method OnPopulate in Cache.
CacheException
- if any error occured while running the method.public static java.lang.Integer Populate(Database db) throws CacheException
Runs method Populate in Cache.
Description: Creates up to count instances an object and stores them in the database.
If verbose is true, then details are echoed to the console.
If DeferIndices is true, then indices are sorted at the end of the operation.
Returns the number of instances successfully created.
For more information refer to About Populate.
db
- represented as Database
default argument count set to 10
default argument verbose set to 0
default argument DeferIndices set to 1
default argument objects set to 0
CacheException
- if any error occured while running the method.Populate(Database,java.lang.Integer,java.lang.Integer,java.lang.Integer,com.intersys.objects.IntegerHolder)
,
Method Populatepublic static java.lang.Integer Populate(Database db, java.lang.Integer count) throws CacheException
Runs method Populate in Cache.
Description: Creates up to count instances an object and stores them in the database.
If verbose is true, then details are echoed to the console.
If DeferIndices is true, then indices are sorted at the end of the operation.
Returns the number of instances successfully created.
For more information refer to About Populate.
db
- represented as Databasecount
- represented as java.lang.Integer
default argument verbose set to 0
default argument DeferIndices set to 1
default argument objects set to 0
CacheException
- if any error occured while running the method.Populate(Database,java.lang.Integer,java.lang.Integer,java.lang.Integer,com.intersys.objects.IntegerHolder)
,
Method Populatepublic static java.lang.Integer Populate(Database db, java.lang.Integer count, java.lang.Integer verbose) throws CacheException
Runs method Populate in Cache.
Description: Creates up to count instances an object and stores them in the database.
If verbose is true, then details are echoed to the console.
If DeferIndices is true, then indices are sorted at the end of the operation.
Returns the number of instances successfully created.
For more information refer to About Populate.
db
- represented as Databasecount
- represented as java.lang.Integerverbose
- represented as java.lang.Integer
default argument DeferIndices set to 1
default argument objects set to 0
CacheException
- if any error occured while running the method.Populate(Database,java.lang.Integer,java.lang.Integer,java.lang.Integer,com.intersys.objects.IntegerHolder)
,
Method Populatepublic static java.lang.Integer Populate(Database db, java.lang.Integer count, java.lang.Integer verbose, java.lang.Integer DeferIndices) throws CacheException
Runs method Populate in Cache.
Description: Creates up to count instances an object and stores them in the database.
If verbose is true, then details are echoed to the console.
If DeferIndices is true, then indices are sorted at the end of the operation.
Returns the number of instances successfully created.
For more information refer to About Populate.
db
- represented as Databasecount
- represented as java.lang.Integerverbose
- represented as java.lang.IntegerDeferIndices
- represented as java.lang.Integer
default argument objects set to 0
CacheException
- if any error occured while running the method.Populate(Database,java.lang.Integer,java.lang.Integer,java.lang.Integer,com.intersys.objects.IntegerHolder)
,
Method Populatepublic static java.lang.Integer Populate(Database db, java.lang.Integer count, java.lang.Integer verbose, java.lang.Integer DeferIndices, IntegerHolder objects) throws CacheException
Runs method Populate in Cache.
Description: Creates up to count instances an object and stores them in the database.
If verbose is true, then details are echoed to the console.
If DeferIndices is true, then indices are sorted at the end of the operation.
Returns the number of instances successfully created.
For more information refer to About Populate.
db
- represented as Databasecount
- represented as java.lang.Integerverbose
- represented as java.lang.IntegerDeferIndices
- represented as java.lang.Integerobjects
- represented as com.intersys.objects.IntegerHolder
CacheException
- if any error occured while running the method.public static java.lang.String PopulateSerial(Database db) throws CacheException
Runs method PopulateSerial in Cache.
Description: Create a single instance of a serial object.
db
- represented as Database
CacheException
- if any error occured while running the method.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |