info.archinnov.achilles.annotations

Annotation Type SASI

@Retention(value=RUNTIME)
 @Target(value=FIELD)
 @Documented
public @interface SASI

Annotation for SASI index

The following combinations are allowed for index options:

Data type	Index Mode	Analyzer Class	Possible option values
Text or Ascii	PREFIX or CONTAINS	NoOpAnalyzer	analyzed = false (DEFAULT) normalization = NONE (DEFAULT) locale is ignored maxCompactionFlushMemoryInMb (OPTIONAL) enableStemming = false (DEFAULT) skipStopWords = false (DEFAULT)
Text or Ascii	PREFIX or CONTAINS	NonTokenizingAnalyzer	analyzed = true (MANDATORY) normalization (OPTIONAL) locale (OPTIONAL) maxCompactionFlushMemoryInMb (OPTIONAL) enableStemming = false (DEFAULT) skipStopWords = false (DEFAULT)
Text or Ascii	PREFIX or CONTAINS	StandardAnalyzer	analyzed = true (MANDATORY) normalization (OPTIONAL) locale (OPTIONAL) maxCompactionFlushMemoryInMb (OPTIONAL) enableStemming = false (DEFAULT) skipStopWords = false (DEFAULT)
Non Text	PREFIX OR SPARSE	NoOpAnalyzer	analyzed = false (DEFAULT) normalization = NONE (DEFAULT) locale is ignored maxCompactionFlushMemoryInMb (OPTIONAL) enableStemming = false (DEFAULT) skipStopWords = false (DEFAULT)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	analyzed Indicates whether the data should be analyzed or not.
SASI.Analyzer	analyzerClass Defines the analyzer class.
boolean	enableStemming Enable stemming of input text.
SASI.IndexMode	indexMode SASI index mode.
String	locale Defines the locale for tokenization.
int	maxCompactionFlushMemoryInMb Maximum size of SASI data to keep in memory during compaction process.
String	name Optional.
SASI.Normalization	normalization Defines the normalization to be applied to the input.
boolean	skipStopWords Enable stemming of input text.

Element Detail

name

public abstract String name

Optional. Define the name of the SASI index. If not set, defaults to table name_field name_index

 @Table
 public class User {
 ...
 @SASI(name = "country_code_index")
 @Column
 private String countryCode;
 ...
 }
 

If the index name was not set above, it would default to user_countrycode_index

Default:

""

indexMode

public abstract SASI.IndexMode indexMode

SASI index mode. Allowed values are:

• PREFIX (DEFAULT): allows search on prefix for text/ascii data types. Default and only valid index mode for non-text data types
• CONTAINS: allows search on prefix, suffix and substring for text/ascii data types. Invalid for non-text data types
• SPARSE: only valid for non-text data types. SPARSE mode is optimized for low-cardinality e.g. for indexed values having 5 or less corresponding rows. If there are more than 5 CQL rows having this index value, SASI will complain by throwing an exception

Default:

info.archinnov.achilles.annotations.SASI.IndexMode.PREFIX

analyzed

public abstract boolean analyzed

Indicates whether the data should be analyzed or not.

Setting 'analyzed' = true is only valid for text/ascii data types.

Setting 'analyzed' = true is mandatory if 'analyzerClass' is set to:

• NON_TOKENIZING_ANALYZER
• STANDARD_ANALYZER

Default:

false

analyzerClass

public abstract SASI.Analyzer analyzerClass

Defines the analyzer class. Available values are:

• NO_OP_ANALYSER (DEFAULT): do not analyze the input
• NON_TOKENIZING_ANALYZER: only valid for text/ascii data types. Do not tokenize the input. Normalization by lowercase/uppercase is allowed
• STANDARD_ANALYZER: only valid for text/ascii data types. Split the input text into tokens, using the locale defined by attribute 'locale' Normalization by lowercase/uppercase is allowed

Please note that setting 'analyzerClass' to NON_TOKENIZING_ANALYZER or STANDARD_ANALYZER also requires setting 'analyzed' to true

Default:

info.archinnov.achilles.annotations.SASI.Analyzer.NO_OP_ANALYZER

maxCompactionFlushMemoryInMb

public abstract int maxCompactionFlushMemoryInMb

Maximum size of SASI data to keep in memory during compaction process.

Default = 1024 e.g. 1Gb

If there are more than 'maxCompactionFlushMemoryInMb' worth of index data, SASI will flush them on temporary files on disk before merging all the temp files into a single one. Of course it will add up to compaction duration. No free lunch, sorry

Default:

1024

normalization

public abstract SASI.Normalization normalization

Defines the normalization to be applied to the input. Available values are:

• NONE (DEFAULT): no normalization
• LOWERCASE: normalize input text and search term to lower case
• UPPERCASE: normalize input text and search term to upper case

Default:

info.archinnov.achilles.annotations.SASI.Normalization.NONE

locale

public abstract String locale

Defines the locale for tokenization. This attribute is only used when 'analyzerClass' == STANDARD_ANALYZER otherwise it is ignored

Default:

"en"

enableStemming

public abstract boolean enableStemming

Enable stemming of input text. This attribute is only used when 'analyzerClass' == STANDARD_ANALYZER

Default:

false

skipStopWords

public abstract boolean skipStopWords

Enable stemming of input text. This attribute is only used when 'analyzerClass' == STANDARD_ANALYZER

Default:

false