IndexDefinition ("The Adobe AEM Quickstart and Web Application.")

java.lang.Object
- org.apache.jackrabbit.oak.plugins.index.lucene.IndexDefinition

All Implemented Interfaces:: Aggregate.AggregateMapper

public final class IndexDefinition
extends Object
implements Aggregate.AggregateMapper

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IndexDefinition.Builder

class IndexDefinition.IndexingRule

Nested Classes
Modifier and Type	Class and Description
`static class`	`IndexDefinition.Builder`
`class`	`IndexDefinition.IndexingRule`

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_MAX_FIELD_LENGTH
Default value for property maxFieldLength.

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_FIELD_LENGTH` Default value for property `maxFieldLength`.

Constructor Summary

Constructors
Constructor and Description

IndexDefinition(NodeState root, NodeState defn, String indexPath)

Constructors
Constructor and Description
`IndexDefinition(NodeState root, NodeState defn, String indexPath)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`evaluatePathRestrictions()`
`boolean`	`getActiveDeleteEnabled()`
`org.apache.jackrabbit.oak.plugins.index.lucene.Aggregate`	`getAggregate(String nodeType)`
`Analyzer`	`getAnalyzer()`
`IndexDefinition.IndexingRule`	`getApplicableIndexingRule(NodeState state)` Returns the first indexing rule that applies to the given node `state`.
`IndexDefinition.IndexingRule`	`getApplicableIndexingRule(String primaryNodeType)`
`int`	`getBlobSize()` Size in bytes for the blobs created while storing the index content
`Codec`	`getCodec()`
`double`	`getCostPerEntry()`
`double`	`getCostPerExecution()`
`List<IndexDefinition.IndexingRule>`	`getDefinedRules()`
`NodeState`	`getDefinitionNodeState()`
`long`	`getEntryCount()`
`long`	`getFulltextEntryCount(long numOfDocs)`
`String`	`getFunctionName()`
`String`	`getIndexName()`
`String`	`getIndexPath()`
`int`	`getMaxExtractLength()`
`int`	`getNumberOfTopFacets()`
`PathFilter`	`getPathFilter()`
`String[]`	`getQueryPaths()`
`long`	`getReindexCount()`
`String`	`getScorerProviderName()`
`int`	`getSuggesterUpdateFrequencyMinutes()`
`InputStream`	`getTikaConfig()`
`String`	`getUniqueId()`
`IndexFormatVersion`	`getVersion()`
`boolean`	`hasCustomTikaConfig()`
`boolean`	`hasFunctionDefined()`
`boolean`	`hasMatchingNodeTypeReg(NodeState root)`
`static boolean`	`hasPersistedIndex(NodeState definition)` Check if the index definition is fresh of some index has happened
`static boolean`	`isDisableStoredIndexDefinition()`
`boolean`	`isEntryCountDefined()`
`boolean`	`isFullTextEnabled()`
`boolean`	`isNRTIndexingEnabled()`
`boolean`	`isOfOldFormat()`
`boolean`	`isSecureFacets()`
`boolean`	`isSpellcheckEnabled()`
`boolean`	`isSuggestAnalyzed()`
`boolean`	`isSuggestEnabled()`
`boolean`	`isSyncIndexingEnabled()`
`boolean`	`isTestMode()`
`static IndexDefinition.Builder`	`newBuilder(NodeState root, NodeState defn, String indexPath)`
`boolean`	`saveDirListing()`
`static void`	`setDisableStoredIndexDefinition(boolean disableStoredIndexDefinitionDefault)`
`static boolean`	`supportsSyncOrNRTIndexing(NodeBuilder defn)`
`String`	`toString()`
`static NodeBuilder`	`updateDefinition(NodeBuilder indexDefn)`
`static NodeBuilder`	`updateDefinition(NodeBuilder indexDefn, String indexPath)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- DEFAULT_MAX_FIELD_LENGTH
```
public static final int DEFAULT_MAX_FIELD_LENGTH
```
  Default value for property maxFieldLength.
  
  See Also:
  
  Constant Field Values

Constructor Detail

IndexDefinition

public IndexDefinition(NodeState root,
                       NodeState defn,
                       String indexPath)

Method Detail

newBuilder

public static IndexDefinition.Builder newBuilder(NodeState root,
                                                 NodeState defn,
                                                 String indexPath)

getDefinitionNodeState

public NodeState getDefinitionNodeState()

isFullTextEnabled
```
public boolean isFullTextEnabled()
```

getFunctionName
```
public String getFunctionName()
```

hasFunctionDefined
```
public boolean hasFunctionDefined()
```

getBlobSize
```
public int getBlobSize()
```
Size in bytes for the blobs created while storing the index content

Returns:

size in bytes

getCodec
```
public Codec getCodec()
```

getReindexCount
```
public long getReindexCount()
```

getEntryCount
```
public long getEntryCount()
```

getSuggesterUpdateFrequencyMinutes

public int getSuggesterUpdateFrequencyMinutes()

isEntryCountDefined
```
public boolean isEntryCountDefined()
```

getCostPerEntry
```
public double getCostPerEntry()
```

getCostPerExecution
```
public double getCostPerExecution()
```

getFulltextEntryCount

public long getFulltextEntryCount(long numOfDocs)

getVersion

public IndexFormatVersion getVersion()

isOfOldFormat
```
public boolean isOfOldFormat()
```

isTestMode
```
public boolean isTestMode()
```

evaluatePathRestrictions

public boolean evaluatePathRestrictions()

getAnalyzer
```
public Analyzer getAnalyzer()
```

hasCustomTikaConfig
```
public boolean hasCustomTikaConfig()
```

getTikaConfig
```
public InputStream getTikaConfig()
```

getIndexName
```
public String getIndexName()
```

getMaxExtractLength
```
public int getMaxExtractLength()
```

getScorerProviderName
```
public String getScorerProviderName()
```

saveDirListing
```
public boolean saveDirListing()
```

getPathFilter
```
public PathFilter getPathFilter()
```

getQueryPaths
```
public String[] getQueryPaths()
```

getUniqueId
```
public String getUniqueId()
```

isNRTIndexingEnabled
```
public boolean isNRTIndexingEnabled()
```

isSyncIndexingEnabled

public boolean isSyncIndexingEnabled()

hasPersistedIndex
```
public static boolean hasPersistedIndex(NodeState definition)
```
Check if the index definition is fresh of some index has happened

Parameters:

definition - nodestate for Index Definition

Returns:

true if index has some indexed content

isDisableStoredIndexDefinition

public static boolean isDisableStoredIndexDefinition()

setDisableStoredIndexDefinition

public static void setDisableStoredIndexDefinition(boolean disableStoredIndexDefinitionDefault)

toString
```
public String toString()
```
Overrides:

toString in class Object

getAggregate

public org.apache.jackrabbit.oak.plugins.index.lucene.Aggregate getAggregate(String nodeType)

Specified by:: getAggregate in interface Aggregate.AggregateMapper

hasMatchingNodeTypeReg

public boolean hasMatchingNodeTypeReg(NodeState root)

getDefinedRules

public List<IndexDefinition.IndexingRule> getDefinedRules()

getApplicableIndexingRule

public IndexDefinition.IndexingRule getApplicableIndexingRule(String primaryNodeType)

getApplicableIndexingRule
```
public IndexDefinition.IndexingRule getApplicableIndexingRule(NodeState state)
```
Returns the first indexing rule that applies to the given node state.

Parameters:

state - a node state.

Returns:

the indexing rule or null if none applies.

isSuggestEnabled
```
public boolean isSuggestEnabled()
```

isSpellcheckEnabled
```
public boolean isSpellcheckEnabled()
```

getIndexPath
```
public String getIndexPath()
```

isSuggestAnalyzed
```
public boolean isSuggestAnalyzed()
```

isSecureFacets
```
public boolean isSecureFacets()
```

getNumberOfTopFacets
```
public int getNumberOfTopFacets()
```

updateDefinition

public static NodeBuilder updateDefinition(NodeBuilder indexDefn)

updateDefinition

public static NodeBuilder updateDefinition(NodeBuilder indexDefn,
                                           String indexPath)

getActiveDeleteEnabled

public boolean getActiveDeleteEnabled()

supportsSyncOrNRTIndexing

public static boolean supportsSyncOrNRTIndexing(NodeBuilder defn)

Class IndexDefinition

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_FIELD_LENGTH

Constructor Detail

IndexDefinition

Method Detail

newBuilder

getDefinitionNodeState

isFullTextEnabled

getFunctionName

hasFunctionDefined

getBlobSize

getCodec

getReindexCount

getEntryCount

getSuggesterUpdateFrequencyMinutes

isEntryCountDefined

getCostPerEntry

getCostPerExecution

getFulltextEntryCount

getVersion

isOfOldFormat

isTestMode

evaluatePathRestrictions

getAnalyzer

hasCustomTikaConfig

getTikaConfig

getIndexName

getMaxExtractLength

getScorerProviderName

saveDirListing

getPathFilter

getQueryPaths

getUniqueId

isNRTIndexingEnabled

isSyncIndexingEnabled

hasPersistedIndex

isDisableStoredIndexDefinition

setDisableStoredIndexDefinition

toString

getAggregate

hasMatchingNodeTypeReg

getDefinedRules

getApplicableIndexingRule

getApplicableIndexingRule

isSuggestEnabled

isSpellcheckEnabled

getIndexPath

isSuggestAnalyzed

isSecureFacets

getNumberOfTopFacets

updateDefinition

updateDefinition

getActiveDeleteEnabled

supportsSyncOrNRTIndexing