Module org.eclipse.persistence.jpa

Package org.eclipse.persistence.internal.jpa

Class QueryHintsHandler

java.lang.Object

org.eclipse.persistence.internal.jpa.QueryHintsHandler

public class QueryHintsHandler
extends Object

The class processes query hints. EclipseLink query hints and their values defined in org.eclipse.persistence.config package. To add a new query hint: Define a new hint in QueryHints; Add a class containing hint's values if required to config package (like CacheUsage); Alternatively values defined in HintValues may be used - Refresh and BindParameters hints do that. Add an inner class to this class extending Hint corresponding to the new hint (like CacheUsageHint); The first constructor parameter is hint name; the second is default value; In constructor provide 2-dimensional value array in case the values should be translated (currently all Hint classes do that); in case translation is not required provide a single-dimension array (no such examples yet). In inner class Hint static initializer addHint an instance of the new hint class (like addHint(new CacheUsageHint())).

See Also:

QueryHints, HintValues, CacheUsage, PessimisticLock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	QueryHintsHandler.AllowNativeSQLQueryHint
protected static class	QueryHintsHandler.AsOfHint
protected static class	QueryHintsHandler.AsOfSCNHint
protected static class	QueryHintsHandler.BatchHint
protected static class	QueryHintsHandler.BatchSizeHint
protected static class	QueryHintsHandler.BatchTypeHint
protected static class	QueryHintsHandler.BatchWriteHint	Configure the cache usage of the query.
protected static class	QueryHintsHandler.BindParametersHint
protected static class	QueryHintsHandler.CacheRetrieveModeHint
protected static class	QueryHintsHandler.CacheRetrieveModeLegacyHint
protected static class	QueryHintsHandler.CacheStatementHint
protected static class	QueryHintsHandler.CacheStoreModeHint
protected static class	QueryHintsHandler.CacheStoreModeLegacyHint
protected static class	QueryHintsHandler.CacheUsageHint	Configure the cache usage of the query.
protected static class	QueryHintsHandler.CascadePolicyHint
protected static class	QueryHintsHandler.CompositeMemberHint
protected static class	QueryHintsHandler.CursorHint
protected static class	QueryHintsHandler.CursorInitialSizeHint
protected static class	QueryHintsHandler.CursorPageSizeHint
protected static class	QueryHintsHandler.CursorSizeHint
protected static class	QueryHintsHandler.ExclusiveHint
protected static class	QueryHintsHandler.FetchGraphHint
protected static class	QueryHintsHandler.FetchGroupAttributeHint
protected static class	QueryHintsHandler.FetchGroupDefaultHint
protected static class	QueryHintsHandler.FetchGroupHint
protected static class	QueryHintsHandler.FetchGroupLoadHint
protected static class	QueryHintsHandler.FetchGroupNameHint
protected static class	QueryHintsHandler.FetchHint
protected static class	QueryHintsHandler.FlushHint
protected static class	QueryHintsHandler.Hint	Define a generic Hint.
protected static class	QueryHintsHandler.HintHint
protected static class	QueryHintsHandler.IndirectionPolicyHint
protected static class	QueryHintsHandler.InheritanceJoinHint
protected static class	QueryHintsHandler.JDBCFetchSizeHint
protected static class	QueryHintsHandler.JDBCFirstResultHint
protected static class	QueryHintsHandler.JDBCMaxRowsHint
protected static class	QueryHintsHandler.JDBCTimeoutHint
protected static class	QueryHintsHandler.LeftFetchHint
protected static class	QueryHintsHandler.LoadGraphHint
protected static class	QueryHintsHandler.LoadGroupAttributeHint
protected static class	QueryHintsHandler.LoadGroupHint
protected static class	QueryHintsHandler.MaintainCacheHint
protected static class	QueryHintsHandler.NativeConnectionHint
protected static class	QueryHintsHandler.ParameterDelimiterHint	INTERNAL: 325167: Make reserved # bind parameter char generic to enable native SQL pass through
protected static class	QueryHintsHandler.PartitioningHint
protected static class	QueryHintsHandler.PessimisticLockHint
protected static class	QueryHintsHandler.PessimisticLockScope
protected static class	QueryHintsHandler.PessimisticLockTimeoutHint
protected static class	QueryHintsHandler.PessimisticLockTimeoutUnitHint
protected static class	QueryHintsHandler.PrepareHint
protected static class	QueryHintsHandler.PrintInnerJoinInWhereClauseHint
protected static class	QueryHintsHandler.QueryCacheExpiryHint	Define the query cache expiry hint.
protected static class	QueryHintsHandler.QueryCacheExpiryTimeOfDayHint	Define the query cache expiry time of day hint.
protected static class	QueryHintsHandler.QueryCacheHint	Define the query cache hint.
protected static class	QueryHintsHandler.QueryCacheIgnoreNullHint	Define the query cache ignore null hint.
protected static class	QueryHintsHandler.QueryCacheInvalidateOnChangeHint	Define the query cache ignore null hint.
protected static class	QueryHintsHandler.QueryCacheRandomizedExpiryHint	Define the query cache randomized expiry hint.
protected static class	QueryHintsHandler.QueryCacheSizeHint	Define the query cache size hint.
protected static class	QueryHintsHandler.QueryCacheTypeHint	Define the query cache type hint.
protected static class	QueryHintsHandler.QueryResultsCacheValidation
protected static class	QueryHintsHandler.QueryTimeoutHint
protected static class	QueryHintsHandler.QueryTimeoutUnitHint
protected static class	QueryHintsHandler.QueryTypeHint	Configure the type of the query.
protected static class	QueryHintsHandler.ReadOnlyHint
protected static class	QueryHintsHandler.RedirectorHint
protected static class	QueryHintsHandler.RefreshHint
protected static class	QueryHintsHandler.ResultCollectionTypeHint
protected static class	QueryHintsHandler.ResultSetAccess
protected static class	QueryHintsHandler.ResultSetConcurrencyHint
protected static class	QueryHintsHandler.ResultSetTypeHint
protected static class	QueryHintsHandler.ResultTypeHint
protected static class	QueryHintsHandler.ReturnNameValuePairsHint	This hint can be used to indicate whether or not a ResultSetMapping query should return populated DatabaseRecords vs.
protected static class	QueryHintsHandler.ScrollableCursorHint
protected static class	QueryHintsHandler.SerializedObject

Field Summary

Fields

Modifier and Type	Field	Description
static String	QUERY_HINT_PROPERTY

Method Summary

Modifier and Type	Method	Description
static DatabaseQuery	apply(String hintName, Object hintValue, DatabaseQuery query, ClassLoader loader, AbstractSession activeSession)	Applies the hint to the query.
static DatabaseQuery	apply(Map<String,Object> hints, DatabaseQuery query, ClassLoader loader, AbstractSession activeSession)	Applies the hints to the query.
static Set<String>	getSupportedHints()
static boolean	parseBooleanHint(Object hint)	Common hint value processing into an boolean value.
static int	parseIntegerHint(Object hint, String hintName)	Common hint value processing into an integer value.
protected static boolean	shouldUseDefault(Object hintValue)	Empty String hintValue indicates that the default hint value should be used.
static void	verify(String hintName, Object hintValue, String queryName, AbstractSession session)	Verifies the hint.
static void	verify(Map hints, String queryName, AbstractSession session)	Verifies the hints.

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_HINT_PROPERTY

public static final String QUERY_HINT_PROPERTY

See Also:

Constant Field Values

Method Detail

verify

public static void verify(Map hints,
                          String queryName,
                          AbstractSession session)

Verifies the hints. If session != null then logs a FINEST message for each hint. queryName parameter used only for identifying the query in messages, if it's null then "null" will be used. Throws IllegalArgumentException in case the hint value is illegal.

verify

public static void verify(String hintName,
                          Object hintValue,
                          String queryName,
                          AbstractSession session)

Verifies the hint. If session != null then logs a FINEST message. queryName parameter used only for identifying the query in messages, if it's null then "null" will be used. Throws IllegalArgumentException in case the hint value is illegal.

apply

public static DatabaseQuery apply(Map<String,Object> hints,
                                  DatabaseQuery query,
                                  ClassLoader loader,
                                  AbstractSession activeSession)

Applies the hints to the query. Throws IllegalArgumentException in case the hint value is illegal.

apply

public static DatabaseQuery apply(String hintName,
                                  Object hintValue,
                                  DatabaseQuery query,
                                  ClassLoader loader,
                                  AbstractSession activeSession)

Applies the hint to the query. Throws IllegalArgumentException in case the hint value is illegal.

parseBooleanHint

public static boolean parseBooleanHint(Object hint)

Common hint value processing into an boolean value. If the hint is null, false is returned. Those methods that need to handle a null hint to be something other than false should not call this method.

parseIntegerHint

public static int parseIntegerHint(Object hint,
                                   String hintName)

Common hint value processing into an integer value. If the hint is null, -1 is returned.

shouldUseDefault

protected static boolean shouldUseDefault(Object hintValue)

Empty String hintValue indicates that the default hint value should be used.

getSupportedHints

public static Set<String> getSupportedHints()