|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.engine.TWGObject
com.tivoli.twg.engine.TWGPersistentObject
com.tivoli.twg.engine.TWGFilterFactory
A TWGFilterFactory instance defines a list of database tables that appear on the edit dynamic groups panel. TWGFilterFactoryInstances are created during extension initialization in the initClassInstances method of the extension's TWGExtension subclass.
TWGExtension
Field Summary |
---|
Fields inherited from class com.tivoli.twg.engine.TWGPersistentObject |
---|
CLASS_NAME, SIZEOF_BYTE, SIZEOF_CHAR, SIZEOF_DOUBLE, SIZEOF_FLOAT, SIZEOF_INT, SIZEOF_LONG, SIZEOF_SHORT |
Constructor Summary | |
---|---|
TWGFilterFactory()
Default constructor for persistent data restore |
|
TWGFilterFactory(java.lang.String id,
TWGFilterFactoryParms parms)
Constructor for TWGFilterFactory |
Method Summary | |
---|---|
boolean |
addTable(java.lang.String table_class)
Class method to add a table to the list of tables for this filter factory |
protected java.lang.String |
createFilterSQL(TWGFilterConstraint con,
boolean full)
Instance method to generate the SQL for a filter constraint. |
void |
delete()
This method is protected as an implementation side effect. |
static TWGFilterFactory |
findByIdString(java.lang.String id)
Find a particular filter factory by its id string. |
void |
flatten(TWGByteArrayOutputStream data)
Write table contents to a byte array. |
java.lang.String |
getBundleString(java.lang.String bundleKey,
java.util.Locale loc)
Look up a value in a resource bundle |
java.lang.String |
getDisplayName(java.util.Locale loc)
Instance method to get the filter factory display name. |
protected MultiLocaleBundle |
getFactoryMultiLocaleBundle(java.lang.String bundleName)
Get the multiLocaleBundle used for translating factory titles |
static com.tivoli.twg.engine.TWGFilterFactoriesInfo |
getFilterFactories(java.util.Locale loc,
boolean doColumnInfo)
Class method to get the filter factory information for all known factories. |
java.lang.String |
getId()
Instance method to get the id string for this factory |
com.tivoli.twg.engine.TWGFilterFactoryInfo |
getInfo(java.util.Locale loc,
boolean doColumnInfo)
Instance method to get the filter factory information for display on console |
com.tivoli.twg.engine.TWGFilterFactoryTableInfo |
getTableInfo(java.lang.String token,
java.util.Locale loc)
Instance method to get the table information for a specific table in the factory |
void |
removeTable(java.lang.String table_class)
Class method to remove table to the list of tables for this filter factory |
protected void |
restoreData(TWGPersistentObjectDictionary dict,
boolean do_resolve)
Restore method for filter factory object |
protected void |
saveData(TWGPersistentObjectDictionary dict)
Method for saving persistent object data. |
protected static void |
setFactoryList(com.tivoli.twg.engine.TWGFilterFactoryList list)
Class method set factories with the factory list object. |
java.lang.String |
toString()
Convert object to String for debug |
Methods inherited from class com.tivoli.twg.engine.TWGPersistentObject |
---|
Destroy, enableAsyncWrites, fromPersistID, initialize, isNewPersistentStore, isSaveRequired, PersistID, restore, restoreAll, save, save, setSaveRequired, terminate, toPersistID |
Methods inherited from class com.tivoli.twg.engine.TWGObject |
---|
AllObjects, AllObjects, Delete, DumpTWGObjects, FindObject, isDeleted, isNewObject, isPersistent, isPersistent, isValid, isValid, ObjectID, setDistinctObjectID, SetObjectID |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public TWGFilterFactory()
public TWGFilterFactory(java.lang.String id, TWGFilterFactoryParms parms) throws TWGDbException
id
- - unique id string for the filter factory instance
idea to put your company's prefix as part of the factory id
e.g. com.BobCo.FactoryId.1 to keep it unique.parms
- - a TWGFilterFactoryParms object
TWGDbException
TWGFilterFactoryParms
Method Detail |
protected static void setFactoryList(com.tivoli.twg.engine.TWGFilterFactoryList list)
list
- - the TWGFilterFactoryList objectpublic static TWGFilterFactory findByIdString(java.lang.String id)
This method should be run only in the Director engine.
id
- - the id string for the factory
public static com.tivoli.twg.engine.TWGFilterFactoriesInfo getFilterFactories(java.util.Locale loc, boolean doColumnInfo) throws TWGDbException
This method should be run only in the Director engine.
loc
- - the locale to be used for translations.doColumnInfo
- - boolean specifying whether to retrieve column information
TWGDbException
public com.tivoli.twg.engine.TWGFilterFactoryInfo getInfo(java.util.Locale loc, boolean doColumnInfo) throws TWGDbException
This method should be run only in the Director engine.
loc
- - the locale to be used for translations.doColumnInfo
- - boolean specifying whether to retrieve column information
TWGDbException
- if the table is not foundpublic com.tivoli.twg.engine.TWGFilterFactoryTableInfo getTableInfo(java.lang.String token, java.util.Locale loc) throws TWGDbException
This method should be run only in the Director engine.
token
- - the token name for the tableloc
- - the locale to be used for translations.
TWGDbException
- if the table is not foundpublic java.lang.String getDisplayName(java.util.Locale loc)
loc
- - the locale to be used for translations.
protected java.lang.String createFilterSQL(TWGFilterConstraint con, boolean full) throws TWGFilterException
con
- - the TWGFilterConstraint objectfull
- - generate full SQL?
TWGFilterException
public boolean addTable(java.lang.String table_class) throws TWGDbException
table_class
- - the class name for the table
TWGDbException
public void removeTable(java.lang.String table_class) throws TWGDbException
table_class
- - the class name for the table
TWGDbException
protected MultiLocaleBundle getFactoryMultiLocaleBundle(java.lang.String bundleName)
bundleName
- - the name of the resource bundle
public java.lang.String getBundleString(java.lang.String bundleKey, java.util.Locale loc) throws java.util.MissingResourceException
loc
- - locale for the bundle
java.util.MissingResourceException
public java.lang.String getId()
public void delete()
public void flatten(TWGByteArrayOutputStream data)
data
- - the TWGByteArrayOutputStreamprotected void saveData(TWGPersistentObjectDictionary dict) throws TWGPersistentObjectSaveException
saveData
in class TWGPersistentObject
dict
- - dictionary used to accumulate data
TWGPersistentObjectSaveException
- thrown to
abort save procedure.protected void restoreData(TWGPersistentObjectDictionary dict, boolean do_resolve) throws TWGPersistentObjectRestoreException
restoreData
in class TWGPersistentObject
dict
- - dictionary containing data to be restoreddo_resolve
- - true if second pass of restore (do resolve)
TWGPersistentObjectRestoreException
- if restore abortedpublic java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |