Package wt.part

Class WTPartCustomConfigSpec

java.lang.Object
wt.part._WTPartCustomConfigSpec
wt.part.WTPartCustomConfigSpec
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable, ConfigSpec
@GenAsObjectMappable(interfaces=ConfigSpec.class, properties=@GeneratedProperty(name="customConfigSpecAttrHolderRef",type=ObjectReference.class,supportedAPI=PUBLIC)) public class WTPartCustomConfigSpec extends _WTPartCustomConfigSpec
A custom configuration specification expands the structure to the appropriate version using the attributes and the logic provided by the appendSearchCriteria and process APIs.



Supported API: true

Extendable: false

See Also:

  • Method Details

    • appendSearchCriteria

      public QuerySpec appendSearchCriteria(QuerySpec querySpec) throws WTException, QueryException
      Appends to the supplied QuerySpec additional search criteria to reduce the resulting iterations to only those that will be considered by this ConfigSpec. Appending additional classes to the QuerySpec is allowed (for join purposes), but those that are marked as selectable will be trimmed by "filteredIterationsOf" prior to it calling the "process" API.

      The QueryResult returned should be a copy of the passed in one (taking advantage of side-effects is not encouraged).



      Supported API: true
      Parameters:
      querySpec - A QuerySpec with a target class that is Iterated.
      Returns:
      QuerySpec
      Throws:
      WTException
      QueryException
      See Also:

    • process

      public QueryResult process(QueryResult results) throws WTException
      Process the QueryResult of iterations, returning only those that "match" according to the algorithm.

      The QueryResult returned should be a copy of the passed-in QueryResult (side-effects should be avoided).



      Supported API: true
      Parameters:
      results - QueryResult of iterations to filter. Assumed to be the result of a query that included the additional search conditions applied by appendSearchCriteria. Note that after enumerating through the elements of this QueryResult, it should be reset.
      Returns:
      QueryResult
      Throws:
      WTException
      See Also:

    • getAttributesMap

      public Map<String,CustomConfigSpecAttribute> getAttributesMap()
      Getter for an attributes map passed from the client.

      Supported API: true
      Returns:
      Mapinvalid input: '<'String,CustomConfigSpecAttribute>

    • getRelationalConfigSpec

      public Object getRelationalConfigSpec() throws WTException
      Returns the ConfigSpec to use when relationalizing this config spec. This is either a ConfigSpec or a RelationalConfigSpec. A relatianalized config spec utilizes the database (via appendSearchCriteria(QuerySpec)) to remove the need to post-process the QueryResult using ConfigSpec.process(QueryResult).

      Typical return values are:

      • null if the config spec can not/does not support moving everything to the database
      • this if the config spec itself supports relationalization
      • a RelationalConfigSpec (such as the RelationalConfigSpecBridge) which wraps the existing config spec to move processing into the database.

      Note: It is discouraged to return null as config specs that don't support relationalization can not be used by straight-query implementations. For example, it is possible to navigate the WTPartUsageLink and the other side iterations in one database hit by applying a relational config spec; a non-relational config spec would need to navigate to the master in one hit and then resolve the masters to iterations in a second, followed by post-processing to remove unnecessary iterations.

      Supported API: true

      Returns:
      null if the ConfigSpec does not support relationalization, otherwise a config spec that does
      Throws:
      WTException - anticipates the case where factory methods needlessly throw WTExeception