Package org.apache.ignite.internal.processors.query

Class QueryTypeDescriptorImpl

java.lang.Object

org.apache.ignite.internal.processors.query.QueryTypeDescriptorImpl

All Implemented Interfaces:

GridQueryTypeDescriptor

public class QueryTypeDescriptorImpl
extends Object
implements GridQueryTypeDescriptor

Descriptor of type.

Constructor Summary

Constructors

Constructor	Description
QueryTypeDescriptorImpl(String cacheName, CacheObjectContext coCtx)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addFieldToTextIndex(String field)	Adds field to text index.
void	addIndex(QueryIndexDescriptorImpl idx)	Add index.
void	addProperty(GridQueryProperty prop, boolean failOnDuplicate)	Adds property to the type descriptor.
void	addProperty(GridQueryProperty prop, boolean failOnDuplicate, boolean isField)	Adds property to the type descriptor.
int	affinityFieldInlineSize()	Gets affinity fields index INLINE_SIZE.
void	affinityFieldInlineSize(int affFieldInlineSize)	Sets affinity fields index INLINE_SIZE.
String	affinityKey()	Returns affinity key field name or null for default.
void	affinityKey(String affKey)
Map<String,String>	aliases()
void	aliases(Map<String,String> aliases)
String	cacheName()	Gets cache name of this type.
boolean	customAffinityKeyMapper()
void	customAffinityKeyMapper(boolean customAffKeyMapper)
void	dropIndex(String idxName)	Drop index.
LinkedHashMap<String,Class<?>>	fields()	Gets mapping from field name to its type.
boolean	fillAbsentPKsWithDefaults()
boolean	hasField(String field)	Chedk if particular field exists.
boolean	implicitPk()	Gets whether a primary key should be autogenerated.
void	implicitPk(boolean implicitPk)	Sets whether a primary key should be autogenerated.
@Nullable QueryIndexDescriptorImpl	index(String name)	Get index by name.
Map<String,GridQueryIndexDescriptor>	indexes()	Gets indexes for this type.
Collection<QueryIndexDescriptorImpl>	indexes0()
Class<?>	keyClass()	Gets key class.
void	keyClass(Class<?> keyCls)	Set key class.
@Nullable String	keyFieldAlias()	Gets key field alias.
String	keyFieldName()	Gets key field name.
String	keyTypeName()	Gets key type name.
void	keyTypeName(String keyTypeName)	Set key type name.
void	markObsolete()	Mark index as obsolete.
boolean	matchType(CacheObject val)
String	name()	Gets type name which uniquely identifies this type.
void	name(String name)	Sets type name.
boolean	obsolete()
Set<String>	primaryKeyFields()	Gets primary key fields if defined, or empty collection otherwise.
void	primaryKeyFields(Set<String> keys)	Sets primary key fields.
int	primaryKeyInlineSize()	Gets primary key index INLINE_SIZE.
void	primaryKeyInlineSize(int pkInlineSize)	Sets primary key index INLINE_SIZE.
Map<String,GridQueryProperty>	properties()
GridQueryProperty	property(String name)
void	removeProperty(String name)	Removes a property with specified name.
String	schemaName()	Gets schema name for type (database schema means here).
void	schemaName(String schemaName)
void	setDefaults(Object key, Object val)	Sets defaults value for given key and value.
void	setFillAbsentPKsWithDefaults(boolean fillAbsentPKsWithDefaults)	Sets up fillAbsentPKsWithDefaults flag.
void	setValue(String field, Object key, Object val, Object propVal)	Sets field value for given key and value.
String	tableName()	Gets table name for type.
void	tableName(String tblName)	Sets table name for type.
GridQueryIndexDescriptor	textIndex()	Get text index for this type (if any).
String	toString()
int	typeId()
void	typeId(int typeId)
void	validateKeyAndValue(Object key, Object val)	Performs validation of given key and value against configured constraints.
<T> T	value(String field, Object key, Object val)	Gets field value for given key and value.
Class<?>	valueClass()	Gets value class.
void	valueClass(Class<?> valCls)	Sets value class.
@Nullable String	valueFieldAlias()	Gets value field alias.
String	valueFieldName()	Gets value field name.
boolean	valueTextIndex()	Returns true if string representation of value should be indexed as text.
void	valueTextIndex(boolean valTextIdx)	Sets if this value should be text indexed.
String	valueTypeName()	Gets value type name.
void	valueTypeName(String valTypeName)	Set value type name.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryTypeDescriptorImpl

public QueryTypeDescriptorImpl(String cacheName,
                               CacheObjectContext coCtx)

Constructor.

Parameters:

cacheName - Cache name.

coCtx - Cache object context.

Method Detail

cacheName

public String cacheName()

Gets cache name of this type.

Specified by:

cacheName in interface GridQueryTypeDescriptor

Returns:

Cache name.

name

public String name()

Gets type name which uniquely identifies this type.

Specified by:

name in interface GridQueryTypeDescriptor

Returns:

Type name which uniquely identifies this type.

schemaName

public String schemaName()

Gets schema name for type (database schema means here).

Specified by:

schemaName in interface GridQueryTypeDescriptor

Returns:

Schema name.

name

public void name(String name)

Sets type name.

Parameters:

name - Name.

tableName

public String tableName()

Gets table name for type.

Specified by:

tableName in interface GridQueryTypeDescriptor

Returns:

Table name.

tableName

public void tableName(String tblName)

Sets table name for type.

Parameters:

tblName - Table name.

fields

public LinkedHashMap<String,Class<?>> fields()

Gets mapping from field name to its type.

Specified by:

fields in interface GridQueryTypeDescriptor

Returns:

Fields that can be indexed, participate in queries and can be queried using method.

property

public GridQueryProperty property(String name)

Specified by:

property in interface GridQueryTypeDescriptor

Parameters:

name - Property name.

Returns:

Property.

properties

public Map<String,GridQueryProperty> properties()

Specified by:

properties in interface GridQueryTypeDescriptor

Returns:

All properties.

value

public <T> T value(String field,
                   Object key,
                   Object val)
            throws IgniteCheckedException

Gets field value for given key and value.

Specified by:

value in interface GridQueryTypeDescriptor

Parameters:

field - Field name.

key - Key.

val - Value.

Returns:

Value for given field.

Throws:

IgniteCheckedException - If failed.

setValue

public void setValue(String field,
                     Object key,
                     Object val,
                     Object propVal)
              throws IgniteCheckedException

Sets field value for given key and value.

Specified by:

setValue in interface GridQueryTypeDescriptor

Parameters:

field - Field name.

key - Key.

val - Value.

propVal - Value for given field.

Throws:

IgniteCheckedException - If failed.

indexes

public Map<String,GridQueryIndexDescriptor> indexes()

Gets indexes for this type.

Specified by:

indexes in interface GridQueryTypeDescriptor

Returns:

Indexes for this type.

typeId

public int typeId()

Specified by:

typeId in interface GridQueryTypeDescriptor

Returns:

BinaryObject's type ID if indexed value is BinaryObject, otherwise value class' hash code.

matchType

public boolean matchType(CacheObject val)

Specified by:

matchType in interface GridQueryTypeDescriptor

Parameters:

val - Value cache object.

Returns:

true If the type of the given value cache object matches this descriptor.

typeId

public void typeId(int typeId)

Parameters:

typeId - Type ID.

index

@Nullable
public @Nullable QueryIndexDescriptorImpl index(String name)

Get index by name.

Parameters:

name - Name.

Returns:

Index.

indexes0

public Collection<QueryIndexDescriptorImpl> indexes0()

Returns:

Raw index descriptors.

textIndex

public GridQueryIndexDescriptor textIndex()

Get text index for this type (if any).

Specified by:

textIndex in interface GridQueryTypeDescriptor

Returns:

Text index or null.

addIndex

public void addIndex(QueryIndexDescriptorImpl idx)
              throws IgniteCheckedException

Add index.

Parameters:

idx - Index.

Throws:

IgniteCheckedException - If failed.

dropIndex

public void dropIndex(String idxName)

Drop index.

Parameters:

idxName - Index name.

hasField

public boolean hasField(String field)

Chedk if particular field exists.

Parameters:

field - Field.

Returns:

True if exists.

addFieldToTextIndex

public void addFieldToTextIndex(String field)
                         throws IgniteCheckedException

Adds field to text index.

Parameters:

field - Field name.

Throws:

IgniteCheckedException - If failed.

valueClass

public Class<?> valueClass()

Gets value class.

Specified by:

valueClass in interface GridQueryTypeDescriptor

Returns:

Value class.

valueClass

public void valueClass(Class<?> valCls)

Sets value class.

Parameters:

valCls - Value class.

keyClass

public Class<?> keyClass()

Gets key class.

Specified by:

keyClass in interface GridQueryTypeDescriptor

Returns:

Key class.

keyClass

public void keyClass(Class<?> keyCls)

Set key class.

Parameters:

keyCls - Key class.

keyTypeName

public String keyTypeName()

Gets key type name.

Specified by:

keyTypeName in interface GridQueryTypeDescriptor

Returns:

Key type name.

keyTypeName

public void keyTypeName(String keyTypeName)

Set key type name.

Parameters:

keyTypeName - Key type name.

valueTypeName

public String valueTypeName()

Gets value type name.

Specified by:

valueTypeName in interface GridQueryTypeDescriptor

Returns:

Value type name.

valueTypeName

public void valueTypeName(String valTypeName)

Set value type name.

Parameters:

valTypeName - Value type name.

addProperty

public void addProperty(GridQueryProperty prop,
                        boolean failOnDuplicate)
                 throws IgniteCheckedException

Adds property to the type descriptor.

Parameters:

prop - Property.

failOnDuplicate - Fail on duplicate flag.

Throws:

IgniteCheckedException - In case of error.

addProperty

public void addProperty(GridQueryProperty prop,
                        boolean failOnDuplicate,
                        boolean isField)
                 throws IgniteCheckedException

Adds property to the type descriptor.

Parameters:

prop - Property.

failOnDuplicate - Fail on duplicate flag.

isField - True if prop if field, False if prop is "_KEY" or "_VAL".

Throws:

IgniteCheckedException - In case of error.

removeProperty

public void removeProperty(String name)
                    throws IgniteCheckedException

Removes a property with specified name.

Parameters:

name - Name of a property to remove.

Throws:

IgniteCheckedException

schemaName

public void schemaName(String schemaName)

Parameters:

schemaName - Schema name.

valueTextIndex

public boolean valueTextIndex()

Returns true if string representation of value should be indexed as text.

Specified by:

valueTextIndex in interface GridQueryTypeDescriptor

Returns:

If string representation of value should be full-text indexed.

valueTextIndex

public void valueTextIndex(boolean valTextIdx)

Sets if this value should be text indexed.

Parameters:

valTextIdx - Flag value.

affinityKey

public String affinityKey()

Returns affinity key field name or null for default.

Specified by:

affinityKey in interface GridQueryTypeDescriptor

Returns:

Affinity key.

affinityKey

public void affinityKey(String affKey)

Parameters:

affKey - Affinity key field.

customAffinityKeyMapper

public boolean customAffinityKeyMapper()

Specified by:

customAffinityKeyMapper in interface GridQueryTypeDescriptor

Returns:

Whether custom affinity key mapper exists.

customAffinityKeyMapper

public void customAffinityKeyMapper(boolean customAffKeyMapper)

Parameters:

customAffKeyMapper - Whether custom affinity key mapper is set.

aliases

public Map<String,String> aliases()

Returns:

Aliases.

aliases

public void aliases(Map<String,String> aliases)

Parameters:

aliases - Aliases.

obsolete

public boolean obsolete()

Returns:

True if obsolete.

markObsolete

public void markObsolete()

Mark index as obsolete.

toString

public String toString()

Overrides:

toString in class Object

keyFieldName

public String keyFieldName()

Gets key field name.

Specified by:

keyFieldName in interface GridQueryTypeDescriptor

Returns:

Key field name.

valueFieldName

public String valueFieldName()

Gets value field name.

Specified by:

valueFieldName in interface GridQueryTypeDescriptor

Returns:

value field name.

keyFieldAlias

@Nullable
public @Nullable String keyFieldAlias()

Gets key field alias.

Specified by:

keyFieldAlias in interface GridQueryTypeDescriptor

Returns:

Key field alias.

valueFieldAlias

@Nullable
public @Nullable String valueFieldAlias()

Gets value field alias.

Specified by:

valueFieldAlias in interface GridQueryTypeDescriptor

Returns:

value field alias.

validateKeyAndValue

public void validateKeyAndValue(Object key,
                                Object val)
                         throws IgniteCheckedException

Performs validation of given key and value against configured constraints. Throws runtime exception if validation fails.

Specified by:

validateKeyAndValue in interface GridQueryTypeDescriptor

Parameters:

key - Key.

val - Value.

Throws:

IgniteCheckedException

setDefaults

public void setDefaults(Object key,
                        Object val)
                 throws IgniteCheckedException

Sets defaults value for given key and value.

Specified by:

setDefaults in interface GridQueryTypeDescriptor

Parameters:

key - Key.

val - Value.

Throws:

IgniteCheckedException - If failed.

primaryKeyFields

public Set<String> primaryKeyFields()

Gets primary key fields if defined, or empty collection otherwise.

Specified by:

primaryKeyFields in interface GridQueryTypeDescriptor

primaryKeyFields

public void primaryKeyFields(Set<String> keys)

Sets primary key fields.

Specified by:

primaryKeyFields in interface GridQueryTypeDescriptor

Parameters:

keys - Primary keys.

implicitPk

public boolean implicitPk()

Gets whether a primary key should be autogenerated.

Specified by:

implicitPk in interface GridQueryTypeDescriptor

implicitPk

public void implicitPk(boolean implicitPk)

Sets whether a primary key should be autogenerated.

Specified by:

implicitPk in interface GridQueryTypeDescriptor

Parameters:

implicitPk - Whether a PK should be autogenerated.

fillAbsentPKsWithDefaults

public boolean fillAbsentPKsWithDefaults()

Specified by:

fillAbsentPKsWithDefaults in interface GridQueryTypeDescriptor

Returns:

true if absent PK parts should be filled with defaults, false otherwise.

setFillAbsentPKsWithDefaults

public void setFillAbsentPKsWithDefaults(boolean fillAbsentPKsWithDefaults)

Sets up fillAbsentPKsWithDefaults flag.

Specified by:

setFillAbsentPKsWithDefaults in interface GridQueryTypeDescriptor

Parameters:

fillAbsentPKsWithDefaults - Flag.

primaryKeyInlineSize

public int primaryKeyInlineSize()

Gets primary key index INLINE_SIZE.

Specified by:

primaryKeyInlineSize in interface GridQueryTypeDescriptor

primaryKeyInlineSize

public void primaryKeyInlineSize(int pkInlineSize)

Sets primary key index INLINE_SIZE.

Specified by:

primaryKeyInlineSize in interface GridQueryTypeDescriptor

affinityFieldInlineSize

public int affinityFieldInlineSize()

Gets affinity fields index INLINE_SIZE.

Specified by:

affinityFieldInlineSize in interface GridQueryTypeDescriptor

affinityFieldInlineSize

public void affinityFieldInlineSize(int affFieldInlineSize)

Sets affinity fields index INLINE_SIZE.

Specified by:

affinityFieldInlineSize in interface GridQueryTypeDescriptor