Package wt.clients.beans.query

Class WTSchema

java.lang.Object
wt.clients.beans.query.WTPanel
wt.clients.beans.query.WTSchema
All Implemented Interfaces:
ActionListener, Externalizable, Serializable, EventListener
public class WTSchema extends wt.clients.beans.query.WTPanel implements ActionListener, Externalizable
A WTSchema object stores display information for a modeled Windchill business class. It can be used to specify a schema used by WTQuery and WTMultiList objects. It is necessary to create this class with a properly formatted string that contains a fully qualified class name as well as attributes that will be displayed. When defining a schema to be used by a WTQuery object, the formatted string specifies which attributes get displayed in the Tab panel and results list area. When defining a schema to be used by a WTMultiList object, the formatted string specifes the attributes associated with the columns in the list.

The format string is broken up into records. There is a one character code followed by a colon at the beginning of each record, a semi-colon and space combination are used as a separator between records. The one character codes are C, G, A and D.

C is used to specify a fully qualified class name. This must be the first record in the format string.

G is used to specify Text for the search criteria tabs. All attributes that follow will be grouped on that tab, until the next G record.

A is used to specify an attribute used in both the search criteria Tab panel and the results list area. Attributes are displayed in the order they appear in the string.

D is used to specify an attribute used in a multi column list. This includes defining a column in a WTMultiList object and the results list area of a WTQuery object.

For example when defining the schema to be used by a WTQuery object: 

 "C:wt.doc.WTDocument; G:Search Criteria; A:name; D:versionIdentifier; G:More Search Criteria; A:description;"
designates wt.doc.WTDocument as the class that will be queried. The tab panel will contain two tabs labeled Search Criteria and More Search Criteria. The Search Criteria tab will contain an input field for name and versionIdentifier. The More Search Criteria tab will contain an input field for description. The results list area will be set up with columns for name, versionIdentifier and description.

Supported API: true

Extendable: false
See Also:

  • Constructor Details

    • WTSchema

      public WTSchema(String a_schema)
      Constructor specifying a formatted string. The format string is broken up into records. There is a one character code followed by a colon at the beginning of each record, a semi-colon and space combination are used as a separator between records. The one character codes are C, G, A and D.

      C is used to specify a fully qualified class name. This must be the first record in the format string.

      G is used to specify Text for the search criteria tabs. All attributes that follow will be grouped on that tab, until the next G record.

      A is used to specify an attribute used in both the search criteria Tab panel and the results list area. Attributes are displayed in the order they appear in the string.

      D is used to specify an attribute used in a multi column list. This includes defining a column in a WTMultiList object and the results list area of a WTQuery object.

      For example when defining the schema to be used by a WTQuery object: 

       "C:wt.doc.WTDocument; G:Search Criteria; A:name; D:versionIdentifier; G:More Search Criteria; A:description;"
      designates wt.doc.WTDocument as the class that will be queried. The tab panel will contain two tabs labeled Search Criteria and More Search Criteria. The Search Criteria tab will contain an input field for name and versionIdentifier. The More Search Criteria tab will contain an input field for description. The results list area will be set up with columns for name, versionIdentifier and description.

      Supported API: true
      Parameters:
      a_schema - A formatted string.

    • WTSchema

      public WTSchema()
      Default no-arg constructor. If you use this constructor it is necessary to call the setSchema() method.

      Supported API: true
      See Also:

  • Method Details

    • setSchema

      public void setSchema(String a_schema)
      Set the formatted string to be stored in the WTSchema object.

      Supported API: true
      Parameters:
      a_definition_string - A formatted string containing attributes defined for a modeled Windchill business class that are to be used for display purposes.