IndexTemplateComposerImpl (Flowable Work 3.4.0)

java.lang.Object
- com.flowable.indexing.config.composer.IndexTemplateComposerImpl

All Implemented Interfaces:: IndexTemplateComposer

public class IndexTemplateComposerImpl
extends Object
implements IndexTemplateComposer

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`attachmentIndexedChars`
`protected boolean`	`chineseEnabled`
`protected ElasticsearchCompatibility`	`elasticsearchCompatibility`
`protected static org.slf4j.Logger`	`LOGGER`
`protected int`	`ngramEdgeMaxChar`
`protected int`	`ngramEdgeMinChar`
`protected int`	`ngramMaxChar`
`protected int`	`ngramMaxDiff`
`protected int`	`ngramMinChar`
`protected int`	`numberOfReplicas`
`protected int`	`numberOfShards`
`protected com.fasterxml.jackson.databind.ObjectMapper`	`objectMapper`
`protected String`	`refreshInterval`

Constructor Summary

Constructors
Constructor and Description
`IndexTemplateComposerImpl(com.fasterxml.jackson.databind.ObjectMapper objectMapper, ElasticsearchCompatibility elasticsearchCompatibility)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addMappingMetaVersion(CustomIndexConfiguration indexConfiguration, com.fasterxml.jackson.databind.node.ObjectNode mappings)`
`protected void`	`addSettings(CustomIndexConfiguration indexConfiguration, com.fasterxml.jackson.databind.node.ObjectNode jsonNode)` Add the settings to the index template.
`protected String`	`composeCustomAliasTemplate(CustomIndexConfiguration indexConfiguration, String indexPrefix)`
`protected String`	`composeCustomQueryTemplate(CustomIndexConfiguration indexConfiguration)`
`String`	`composeIndexTemplate(CustomIndexConfiguration indexConfiguration, String indexPrefix)` Create the Elasticsearch index template for the given index configuration as a JSON string.
`Map<String,Object>`	`createDefaultIndexSettings()`
`Map<String,Object>`	`createIndexSettings(CustomIndexConfiguration configuration)`
`int`	`getAttachmentIndexedChars()`
`int`	`getNgramEdgeMaxChar()`
`int`	`getNgramEdgeMinChar()`
`int`	`getNgramMaxChar()`
`int`	`getNgramMaxDiff()`
`int`	`getNgramMinChar()`
`int`	`getNumberOfReplicas()`
`int`	`getNumberOfShards()`
`String`	`getRefreshInterval()`
`void`	`setAttachmentIndexedChars(int attachmentIndexedChars)`
`void`	`setChineseEnabled(boolean chineseEnabled)`
`void`	`setNgramEdgeMaxChar(int ngramEdgeMaxChar)`
`void`	`setNgramEdgeMinChar(int ngramEdgeMinChar)`
`void`	`setNgramMaxChar(int ngramMaxChar)`
`void`	`setNgramMaxDiff(int ngramMaxDiff)`
`void`	`setNgramMinChar(int ngramMinChar)`
`void`	`setNumberOfReplicas(int numberOfReplicas)`
`void`	`setNumberOfShards(int numberOfShards)`
`void`	`setRefreshInterval(String refreshInterval)`

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

numberOfShards
```
protected int numberOfShards
```

numberOfReplicas
```
protected int numberOfReplicas
```

refreshInterval
```
protected String refreshInterval
```

attachmentIndexedChars
```
protected int attachmentIndexedChars
```

ngramMinChar
```
protected int ngramMinChar
```

ngramMaxChar
```
protected int ngramMaxChar
```

ngramEdgeMinChar
```
protected int ngramEdgeMinChar
```

ngramEdgeMaxChar
```
protected int ngramEdgeMaxChar
```

ngramMaxDiff
```
protected int ngramMaxDiff
```

chineseEnabled
```
protected boolean chineseEnabled
```

elasticsearchCompatibility

protected ElasticsearchCompatibility elasticsearchCompatibility

Constructor Detail

IndexTemplateComposerImpl

public IndexTemplateComposerImpl(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                 ElasticsearchCompatibility elasticsearchCompatibility)

Method Detail

composeIndexTemplate
```
public String composeIndexTemplate(CustomIndexConfiguration indexConfiguration,
                                   String indexPrefix)
```
Description copied from interface: IndexTemplateComposer

Create the Elasticsearch index template for the given index configuration as a JSON string.

Specified by:

composeIndexTemplate in interface IndexTemplateComposer

Parameters:

indexConfiguration - the index configuration to create the template for

Returns:

the JSON string representation of the index template

composeCustomQueryTemplate

protected String composeCustomQueryTemplate(CustomIndexConfiguration indexConfiguration)

addMappingMetaVersion

protected void addMappingMetaVersion(CustomIndexConfiguration indexConfiguration,
                                     com.fasterxml.jackson.databind.node.ObjectNode mappings)

composeCustomAliasTemplate

protected String composeCustomAliasTemplate(CustomIndexConfiguration indexConfiguration,
                                            String indexPrefix)

addSettings
```
protected void addSettings(CustomIndexConfiguration indexConfiguration,
                           com.fasterxml.jackson.databind.node.ObjectNode jsonNode)
```
Add the settings to the index template. There are meaningful defaults built in, but to overwrite them, simply set their desired values through the appropriate setters while configuring this composer.

Parameters:

jsonNode - the node to add the settings to

createDefaultIndexSettings

public Map<String,Object> createDefaultIndexSettings()

createIndexSettings

public Map<String,Object> createIndexSettings(CustomIndexConfiguration configuration)

getNumberOfShards
```
public int getNumberOfShards()
```

setNumberOfShards

public void setNumberOfShards(int numberOfShards)

getNumberOfReplicas
```
public int getNumberOfReplicas()
```

setNumberOfReplicas

public void setNumberOfReplicas(int numberOfReplicas)

getRefreshInterval
```
public String getRefreshInterval()
```

setRefreshInterval

public void setRefreshInterval(String refreshInterval)

getAttachmentIndexedChars

public int getAttachmentIndexedChars()

setAttachmentIndexedChars

public void setAttachmentIndexedChars(int attachmentIndexedChars)

getNgramMinChar
```
public int getNgramMinChar()
```

setNgramMinChar

public void setNgramMinChar(int ngramMinChar)

getNgramMaxChar
```
public int getNgramMaxChar()
```

setNgramMaxChar

public void setNgramMaxChar(int ngramMaxChar)

getNgramEdgeMinChar
```
public int getNgramEdgeMinChar()
```

setNgramEdgeMinChar

public void setNgramEdgeMinChar(int ngramEdgeMinChar)

getNgramEdgeMaxChar
```
public int getNgramEdgeMaxChar()
```

setNgramEdgeMaxChar

public void setNgramEdgeMaxChar(int ngramEdgeMaxChar)

getNgramMaxDiff
```
public int getNgramMaxDiff()
```

setNgramMaxDiff

public void setNgramMaxDiff(int ngramMaxDiff)

setChineseEnabled

public void setChineseEnabled(boolean chineseEnabled)

Class IndexTemplateComposerImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

objectMapper

numberOfShards

numberOfReplicas

refreshInterval

attachmentIndexedChars

ngramMinChar

ngramMaxChar

ngramEdgeMinChar

ngramEdgeMaxChar

ngramMaxDiff

chineseEnabled

elasticsearchCompatibility

Constructor Detail

IndexTemplateComposerImpl

Method Detail

composeIndexTemplate

composeCustomQueryTemplate

addMappingMetaVersion

composeCustomAliasTemplate

addSettings

createDefaultIndexSettings

createIndexSettings

getNumberOfShards

setNumberOfShards

getNumberOfReplicas

setNumberOfReplicas

getRefreshInterval

setRefreshInterval

getAttachmentIndexedChars

setAttachmentIndexedChars

getNgramMinChar

setNgramMinChar

getNgramMaxChar

setNgramMaxChar

getNgramEdgeMinChar

setNgramEdgeMinChar

getNgramEdgeMaxChar

setNgramEdgeMaxChar

getNgramMaxDiff

setNgramMaxDiff

setChineseEnabled