com.aspc.DBObj.Internal.impl

Class DBObjectSearchPlanV8

java.lang.Object

com.aspc.DBObj.Internal.SearchPlan

com.aspc.DBObj.Internal.DBObjectSearchPlan

com.aspc.DBObj.Internal.impl.DBObjectSearchPlanV8

Direct Known Subclasses:

ContactSearchPlan, DBExcludeSearchPlan, DBFileSearchPlan, DBJobManagerSessionSearchPlan, DBJobSearchPlan, DBJobStatisticSearchPlan, KnowledgeArticlePlan, TaskSearchPlan, TweetSearchPlan

public class DBObjectSearchPlanV8
extends DBObjectSearchPlan

Process formula values before the search. THREAD MODE: SINGLE-THREADED one search plan per query

Since:

26 Oct 2015

Author:

Nigel Leck

Field Summary

Fields inherited from class com.aspc.DBObj.Internal.DBObjectSearchPlan

MAX_JOINS, RESOLUTION_ARCHIVE_CACHE, RESOLUTION_DB_SEARCH, RESOLUTION_FIELD_CACHE, RESOLUTION_FIELD_CACHE_IN, RESOLUTION_FULL_SEARCH, RESOLUTION_LINKAGE_CACHE, RESOLUTION_LOAD_CACHE_IN, RESOLUTION_REVERSED, RESOLUTION_SPLIT_SEARCH

Fields inherited from class com.aspc.DBObj.Internal.SearchPlan

ALWAYS_LOAD_FIELD_CACHE_LIMIT, DEFAULT_TIMEOUT, maxFullListInsteadOfAffirmativeRestriction, maxFullRecordScan, query, RESOLUTION_KNOWN_TO_FAIL, RESOLUTION_UNKOWN

Constructor Summary

Constructors

Constructor and Description
DBObjectSearchPlanV8(DBQuery query) Creates a new Search plan

Method Summary

Modifier and Type	Method and Description
void	addSqlUsed(java.lang.String sql) INTERNAL ONLY record a SQL statement that was used.
void	addTranslateMap(java.util.Map<java.lang.String,TranslateClause> translateMap) Add the list of items
boolean	archiveSearch(LayerSearchResult lsr) do an archive search
protected LayerPlan	createLayerPlan(DBClass dbClass, VirtualDB layer, DBCriteria criteria, boolean useIndex) Create a database layer plan
void	doLayerSearch(LayerSearchResult lsr)
protected PossibleRowsHolder	doReverseSearch(DBPathClause bestClause, DBClause[] clauses) perform a reverse search
int	getMatchEstimatePerRow() the estimated number of rows loaded per row.
protected static boolean	isUsingDefaultSearchPlan(DataSource ds) Reads and returns the value of USE_SUPER_SEARCH_PLAN system property/or DBSystemProperty This is just a feature toggle only.
java.lang.String[]	listSqlUsed() List the SQL statements used.
LayerPlan	makeLayerPlan(VirtualDB layer) The layer plan for selecting the data
PossibleRowsHolder	tryKeyWord() If the criteria contains the MATCHES symbol then try searching the key words index if present and the field is marked as "key words" and the index is clean.
PossibleRowsHolder	tryPlanCache() CAN YOU HANDLE THIS QUERY ? If so return the possible rows here.
PossibleRowsHolder	tryReverseSearch(DBClause usedClause, long currentLoadRows) Try to resolve the search by reversing the clauses.
PossibleRowsHolder	trySplitOR() Split up OR clauses.
PossibleRowsHolder	trySplitSearch() deal with OR clauses
boolean	useClauseInsteadOfFullScan(long estimatedClauseRows) only do this search if we are going to limit loading of records.
boolean	useFullSearch() Should we try the full search option ?
boolean	useLinkageCache() Should we use linkageCache for this search ?

Methods inherited from class com.aspc.DBObj.Internal.SearchPlan

addClauseUsed, checkThirdPhase, checkTimeout, cleanCriteria, getBottomLayer, getCriteria, getDataBase, getEstimatedDatabaseRows, getEstimatedMatchRows, getEstimatedMatchRows, getFirstClausedUsed, getMaxFullListInsteadOfAffirmativeRestriction, getMaxFullRecordScan, getMaximumRequiredRows, getQuery, getResolution, getSecondClausedUsed, getStartTime, getThirdClausedUsed, getTopLayer, isLayerExcluded, setForcePhaseThree, setMasterPlan, setMaxFullListInsteadOfAffirmativeRestriction, setMaxFullRecordScan, setMaximumRequiredRows, setResolution, useCache, willSearchFail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DBObjectSearchPlanV8

public DBObjectSearchPlanV8(@Nonnull
                            DBQuery query)

Creates a new Search plan

Parameters:

query - The query

Method Detail

tryPlanCache

@CheckReturnValue
 @Nullable
public PossibleRowsHolder tryPlanCache()
                                                             throws java.lang.Exception

CAN YOU HANDLE THIS QUERY ? If so return the possible rows here.

The possible rows need to be the super set of rows. The actual filtering will happen in DBResult.

Overrides:

tryPlanCache in class SearchPlan

Returns:

The possible rows from the plan's special cache.

Throws:

java.lang.Exception - A serious problem

tryKeyWord

public PossibleRowsHolder tryKeyWord()
                              throws java.lang.Exception

If the criteria contains the MATCHES symbol then try searching the key words index if present and the field is marked as "key words" and the index is clean.

Specified by:

tryKeyWord in class DBObjectSearchPlan

Returns:

the possible rows ( super set of rows)

Throws:

java.lang.Exception - a serious problem.

trySplitOR

public PossibleRowsHolder trySplitOR()
                              throws java.lang.Exception

Split up OR clauses.

Specified by:

trySplitOR in class DBObjectSearchPlan

Returns:

The possible rows from the plan's special cache.

Throws:

java.lang.Exception - A serious problem

doLayerSearch

public void doLayerSearch(@Nonnull
                          LayerSearchResult lsr)
                   throws java.lang.Exception

Specified by:

doLayerSearch in class SearchPlan

Parameters:

lsr - the result

Throws:

java.lang.Exception - a serious problem

archiveSearch

public boolean archiveSearch(LayerSearchResult lsr)
                      throws java.lang.Exception

do an archive search

Specified by:

archiveSearch in class SearchPlan

Parameters:

lsr - the result

Returns:

the value

Throws:

java.lang.Exception

getMatchEstimatePerRow

public int getMatchEstimatePerRow()

the estimated number of rows loaded per row.

Returns:

the estimated rows needed to check a match.

listSqlUsed

public java.lang.String[] listSqlUsed()

List the SQL statements used.

Specified by:

listSqlUsed in class DBObjectSearchPlan

Returns:

the list of SQL statements

addSqlUsed

public void addSqlUsed(java.lang.String sql)

INTERNAL ONLY record a SQL statement that was used.

Parameters:

sql - the statement to record.

useFullSearch

public boolean useFullSearch()
                      throws java.lang.Exception

Should we try the full search option ?

Specified by:

useFullSearch in class DBObjectSearchPlan

Returns:

TRUE if full search can be used.

Throws:

java.lang.Exception - A serious problem

trySplitSearch

public PossibleRowsHolder trySplitSearch()
                                  throws java.lang.Exception

deal with OR clauses

Specified by:

trySplitSearch in class DBObjectSearchPlan

Returns:

the possible rows

Throws:

java.lang.Exception - a serious problem

tryReverseSearch

public PossibleRowsHolder tryReverseSearch(DBClause usedClause,
                                           long currentLoadRows)
                                    throws java.lang.Exception

Try to resolve the search by reversing the clauses.

  SELECT *
  FROM Dilution
  WHERE instrument.ric like 'A%'
           | |
            V
   Step 1
   -------
   SELECT id
   FROM Asset
   WHERE ric like 'A%'

  Step 2
  -------
  SELECT *
  FROM Dilution
  WHERE instrument IS IN ( 1@10~10 ....)

 

Specified by:

tryReverseSearch in class DBObjectSearchPlan

Parameters:

usedClause - the clause has been used.

currentLoadRows - current estimate

Returns:

possible rows.

Throws:

java.lang.Exception - A serious problem

useClauseInsteadOfFullScan

public boolean useClauseInsteadOfFullScan(long estimatedClauseRows)

only do this search if we are going to limit loading of records. because some reverse searches can actually require more than the total number of rows for the base class to be loaded.

Specified by:

useClauseInsteadOfFullScan in class DBObjectSearchPlan

Parameters:

estimatedClauseRows - the estimate of the rows for this clause.

Returns:

true if we need to use the full scan

doReverseSearch

protected PossibleRowsHolder doReverseSearch(DBPathClause bestClause,
                                             DBClause[] clauses)
                                      throws java.lang.Exception

perform a reverse search

Parameters:

bestClause - best clause

clauses - the clauses

Returns:

the possible rows

Throws:

java.lang.Exception - a serious problem

useLinkageCache

public boolean useLinkageCache()

Should we use linkageCache for this search ?

Specified by:

useLinkageCache in class DBObjectSearchPlan

Returns:

TRUE if we should use linkage cache.

makeLayerPlan

public LayerPlan makeLayerPlan(VirtualDB layer)
                        throws java.lang.Exception

The layer plan for selecting the data

Parameters:

layer - The layer

Returns:

The layer plan.

Throws:

java.lang.Exception - A serious problem

createLayerPlan

protected LayerPlan createLayerPlan(DBClass dbClass,
                                    VirtualDB layer,
                                    DBCriteria criteria,
                                    boolean useIndex)
                             throws java.lang.Exception

Create a database layer plan

Parameters:

dbClass - The class to be searched

layer - The database layer

criteria - The restriction

useIndex - Should we use the indexes ?

Returns:

The layer plan

Throws:

java.lang.Exception - a serious problem.

addTranslateMap

public void addTranslateMap(java.util.Map<java.lang.String,TranslateClause> translateMap)

Description copied from class: DBObjectSearchPlan

Add the list of items

Specified by:

addTranslateMap in class DBObjectSearchPlan

Parameters:

translateMap - the map of alias

isUsingDefaultSearchPlan

@CheckReturnValue
 @Nonnull
protected static boolean isUsingDefaultSearchPlan(@Nonnull
                                                                              DataSource ds)

Reads and returns the value of USE_SUPER_SEARCH_PLAN system property/or DBSystemProperty This is just a feature toggle only. If using super.tryPlanCache() causes any issue then we may use this to switch this off using the property.

Parameters:

ds -

Returns: