IBM DB2 UDB
Plugin Interface
for Extending the Control Center

com.ibm.db2.tools.cc.navigator
Interface CCTreeObject

All Superinterfaces:
CCObject, CCTableObject

public interface CCTreeObject
extends CCTableObject

The CCTreeObject interface allows users to define new objects to be inserted into the Control Center tree and Control Center details view.

The getChildren() method defines new objects as children of a CCTreeObject.

A CCTreeObject can represent an existing Control Center object or a new plugin object type (see getType).

See Also:
CCObject

Field Summary
static int CLOSED_FOLDER
          Folder state is closed
static int OPEN_FOLDER
          Folder state is open.
 
Fields inherited from interface com.ibm.db2.tools.cc.navigator.CCObject
DCS_GATEWAY_CONNECTION, DCS_GATEWAY_CONNECTIONS_FOLDER, NUM_OBJECT_TYPES, S390_ALIAS, S390_ALIASES_FOLDER, S390_APPLICATION_OBJECTS_FOLDER, S390_BUFFERPOOL, S390_BUFFERPOOLS_FOLDER, S390_CATALOG_TABLE, S390_CATALOG_TABLES_FOLDER, S390_COLLECTION, S390_COLLECTIONS_FOLDER, S390_DATABASE, S390_DATABASES_FOLDER, S390_DATASET, S390_DATASET_TEMPLATE, S390_DATASET_TEMPLATES_FOLDER, S390_DATASETS_FOLDER, S390_DB_USER, S390_DB_USERS_FOLDER, S390_DISTINCT_TYPE, S390_DISTINCT_TYPES_FOLDER, S390_INDEX, S390_INDEXS_FOLDER, S390_LOCATION, S390_LOCATIONS_FOLDER, S390_PACKAGE, S390_PACKAGES_FOLDER, S390_PLAN, S390_PLANS_FOLDER, S390_PROCEDURE, S390_PROCEDURES_FOLDER, S390_SCHEMA, S390_SCHEMAS_FOLDER, S390_STORAGE_GROUP, S390_STORAGE_GROUPS_FOLDER, S390_SUBSYSTEM, S390_SUBSYSTEMS_FOLDER, S390_SYNONYM, S390_SYNONYMS_FOLDER, S390_TABLE, S390_TABLES_FOLDER, S390_TABLESPACE, S390_TABLESPACES_FOLDER, S390_TRIGGER, S390_TRIGGERS_FOLDER, S390_USER_DEFINED_FUNCTION, S390_USER_DEFINED_FUNCTIONS_FOLDER, S390_UTILITY_LIST, S390_UTILITY_LISTS_FOLDER, S390_UTILITY_OBJECTS_FOLDER, S390_UTILITY_PROCEDURE, S390_UTILITY_PROCEDURES_FOLDER, S390_VIEW, S390_VIEWS_FOLDER, UDB_ALIAS, UDB_ALIASES_FOLDER, UDB_APPLICATION_OBJECTS_FOLDER, UDB_BUFFERPOOL, UDB_BUFFERPOOLS_FOLDER, UDB_CACHE_OBJECTS_FOLDER, UDB_CACHE_TABLE, UDB_CACHE_TABLES_FOLDER, UDB_CONNECTION, UDB_CONNECTIONS_FOLDER, UDB_CTEINDEX, UDB_CTEINDEXES_FOLDER, UDB_DATABASE, UDB_DATABASES_FOLDER, UDB_DB_GROUP, UDB_DB_GROUPS_FOLDER, UDB_DB_USER, UDB_DB_USERS_FOLDER, UDB_DRDA_TABLE, UDB_DRDA_TABLES_FOLDER, UDB_EVENT_MONITOR, UDB_EVENT_MONITORS_FOLDER, UDB_FEDERATED_DATABASE_OBJECT, UDB_FEDERATED_DATABASE_OBJECTS_FOLDER, UDB_FEDERATED_NICKNAME, UDB_FEDERATED_NICKNAMES_FOLDER, UDB_FEDERATED_REMOTE_TABLE, UDB_FEDERATED_REMOTE_TABLES_FOLDER, UDB_FEDERATED_SERVER, UDB_FEDERATED_SERVERS_FOLDER, UDB_FEDERATED_STORED_PROCEDURE, UDB_FEDERATED_STORED_PROCEDURES_FOLDER, UDB_FEDERATED_USER_MAPPING, UDB_FEDERATED_USER_MAPPINGS_FOLDER, UDB_FEDERATED_VIEWS_FOLDER, UDB_INDEX, UDB_INDEXES_FOLDER, UDB_INSTANCE, UDB_INSTANCES_FOLDER, UDB_MQT, UDB_MQTS_FOLDER, UDB_NODEGROUP, UDB_NODEGROUPS_FOLDER, UDB_PACKAGE, UDB_PACKAGES_FOLDER, UDB_REPLICATION_SOURCE, UDB_REPLICATION_SOURCES_FOLDER, UDB_REPLICATION_SUBSCRIPTION, UDB_REPLICATION_SUBSCRIPTIONS_FOLDER, UDB_SCHEMA, UDB_SCHEMAS_FOLDER, UDB_STORE_PROCEDURE, UDB_STORE_PROCEDURES_FOLDER, UDB_SYSTEM, UDB_SYSTEMS_FOLDER, UDB_TABLE, UDB_TABLES_FOLDER, UDB_TABLESPACE, UDB_TABLESPACES_FOLDER, UDB_TRIGGER, UDB_TRIGGERS_FOLDER, UDB_USER_AND_GROUP_OBJECTS_FOLDER, UDB_USER_DEFINED_DISTINCT_DATATYPE, UDB_USER_DEFINED_DISTINCT_DATATYPES_FOLDER, UDB_USER_DEFINED_DISTINCT_FUNCTION, UDB_USER_DEFINED_DISTINCT_FUNCTIONS_FOLDER, UDB_USER_DEFINED_METHOD, UDB_USER_DEFINED_METHODS_FOLDER, UDB_USER_DEFINED_STRUCTURED_DATATYPE, UDB_USER_DEFINED_STRUCTURED_DATATYPES_FOLDER, UDB_VIEW, UDB_VIEWS_FOLDER, UDB_XMLREPOSITORY_FOLDER, UDB_XSROBJECT
 
Method Summary
 CCTableObject[] getChildren()
          Returns a vector of CCTableObjects that represent the children of this object.
 boolean isLeaf()
          Returns whether or not this CCTreeObject is a leaf in the Control Center tree.
 
Methods inherited from interface com.ibm.db2.tools.cc.navigator.CCTableObject
getColumns, getData, getIcon, setParentName
 
Methods inherited from interface com.ibm.db2.tools.cc.navigator.CCObject
getMenuActions, getName, getType, isConfigurable, isEditable
 

Field Detail

CLOSED_FOLDER

public static final int CLOSED_FOLDER
Folder state is closed

See Also:
CCTableObject.getIcon(int), Constant Field Values

OPEN_FOLDER

public static final int OPEN_FOLDER
Folder state is open.

See Also:
CCTableObject.getIcon(int), Constant Field Values
Method Detail

getChildren

public CCTableObject[] getChildren()
Returns a vector of CCTableObjects that represent the children of this object.

Depending on the value returned by isLeaf(), these children are shown in the Control Center tree and/or details view when this object is expanded.

This method is called by the Control Center when one of the following events occur:

Note: Adding a new plugin object as a child of an existing Control Center object which is a tree leaf object is not supported. Also adding a new plugin object as a child of an existing Control Center object which is not in the tree is not supported. For example, you can not add a new plugin object under UDB_TABLE objects because UDB_TABLE objects only appear in the details view and not in the Control Center tree.

Returns:
a vector of child CCTableObjects

In cases where the list of children can change, it is recommended that the children be reconstructed before they are returned by this method in order to reflect refreshed current information in the Control Center. Also the children should be stored to and read from persistent storage, so they will appear on subsequent invocations of the Control Center.

The list of children returned may be dependent on which objects are the parents of this object. The Control Center provides the names of the parents of this object in setParentName.


isLeaf

public boolean isLeaf()
Returns whether or not this CCTreeObject is a leaf in the Control Center tree. If isLeaf is true, the children of this object appear in the details view only and not in the tree. If isLeaf is false, the children of this object appear in the details view and in the tree.

Returns:
true if this object is a leaf in the Control Center tree.

IBM DB2 UDB
Plugin Interface
for Extending the Control Center

(C)Copyright IBM Corp. 2002, 2004. All rights reserved.

Links on this page are made available for your convenience and may take you to non-IBM sites. IBM does not warrant any sample code provided on these sites.