java.lang.Object
- org.hibernate.search.engine.search.highlighter.spi.SearchHighlighterBuilder

Direct Known Subclasses:

ElasticsearchSearchHighlighterImpl.Builder, LuceneAbstractSearchHighlighter.Builder
```
public abstract class SearchHighlighterBuilder
extends Object
```

Field Summary

Fields
Modifier and Type	Field	Description
`protected Character[]`	`boundaryChars`
`protected Integer`	`boundaryMaxScan`
`protected Locale`	`boundaryScannerLocale`
`protected BoundaryScannerType`	`boundaryScannerType`
`protected HighlighterEncoder`	`encoder`
`protected HighlighterFragmenter`	`fragmenterType`
`protected Integer`	`fragmentSize`
`protected Integer`	`noMatchSize`
`protected Integer`	`numberOfFragments`
`protected Boolean`	`orderByScore`
`protected Integer`	`phraseLimit`
`protected List<String>`	`postTags`
`protected List<String>`	`preTags`
`protected HighlighterTagSchema`	`tagSchema`
`protected SearchHighlighterType`	`type`

Constructor Summary

Constructors
Constructor Description

SearchHighlighterBuilder()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`Character[]`	`boundaryChars()`
`SearchHighlighterBuilder`	`boundaryChars(Character[] boundaryChars)`
`SearchHighlighterBuilder`	`boundaryChars(String boundaryChars)`
`String`	`boundaryCharsAsString()`
`Integer`	`boundaryMaxScan()`
`SearchHighlighterBuilder`	`boundaryMaxScan(Integer boundaryMaxScan)`
`Locale`	`boundaryScannerLocale()`
`SearchHighlighterBuilder`	`boundaryScannerLocale(Locale boundaryScannerLocale)`
`BoundaryScannerType`	`boundaryScannerType()`
`SearchHighlighterBuilder`	`boundaryScannerType(BoundaryScannerType boundaryScannerType)`
`abstract SearchHighlighter`	`build()`
`void`	`clearTags()`
`HighlighterEncoder`	`encoder()`
`SearchHighlighterBuilder`	`encoder(HighlighterEncoder encoder)`
`SearchHighlighterBuilder`	`fragmenter(HighlighterFragmenter type)`
`HighlighterFragmenter`	`fragmenterType()`
`Integer`	`fragmentSize()`
`SearchHighlighterBuilder`	`fragmentSize(Integer fragmentSize)`
`Integer`	`noMatchSize()`
`SearchHighlighterBuilder`	`noMatchSize(Integer noMatchSize)`
`Integer`	`numberOfFragments()`
`SearchHighlighterBuilder`	`numberOfFragments(Integer numberOfFragments)`
`Boolean`	`orderByScore()`
`SearchHighlighterBuilder`	`orderByScore(Boolean orderByScore)`
`Integer`	`phraseLimit()`
`SearchHighlighterBuilder`	`phraseLimit(Integer phraseLimit)`
`List<String>`	`postTags()`
`List<String>`	`preTags()`
`SearchHighlighterBuilder`	`tag(String preTag, String postTag)`
`SearchHighlighterBuilder`	`tags(Collection<String> preTags, String postTag)`
`SearchHighlighterBuilder`	`tags(Collection<String> preTags, Collection<String> postTags)`
`HighlighterTagSchema`	`tagSchema()`
`SearchHighlighterBuilder`	`tagSchema(HighlighterTagSchema tagSchema)`
`SearchHighlighterType`	`type()`
`SearchHighlighterBuilder`	`type(SearchHighlighterType type)`

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

Field Detail

type
```
protected SearchHighlighterType type
```

boundaryChars
```
protected Character[] boundaryChars
```

boundaryMaxScan
```
protected Integer boundaryMaxScan
```

fragmentSize
```
protected Integer fragmentSize
```

noMatchSize
```
protected Integer noMatchSize
```

numberOfFragments
```
protected Integer numberOfFragments
```

orderByScore
```
protected Boolean orderByScore
```

preTags
```
protected List<String> preTags
```

postTags
```
protected List<String> postTags
```

boundaryScannerType

protected BoundaryScannerType boundaryScannerType

boundaryScannerLocale
```
protected Locale boundaryScannerLocale
```

fragmenterType

protected HighlighterFragmenter fragmenterType

phraseLimit
```
protected Integer phraseLimit
```

encoder
```
protected HighlighterEncoder encoder
```

tagSchema

protected HighlighterTagSchema tagSchema

Constructor Detail
- SearchHighlighterBuilder
```
public SearchHighlighterBuilder()
```

Method Detail

type

public SearchHighlighterBuilder type(SearchHighlighterType type)

boundaryChars

public SearchHighlighterBuilder boundaryChars(String boundaryChars)

boundaryChars

public SearchHighlighterBuilder boundaryChars(Character[] boundaryChars)

boundaryMaxScan

public SearchHighlighterBuilder boundaryMaxScan(Integer boundaryMaxScan)

fragmentSize

public SearchHighlighterBuilder fragmentSize(Integer fragmentSize)

noMatchSize

public SearchHighlighterBuilder noMatchSize(Integer noMatchSize)

numberOfFragments

public SearchHighlighterBuilder numberOfFragments(Integer numberOfFragments)

orderByScore

public SearchHighlighterBuilder orderByScore(Boolean orderByScore)

boundaryScannerType

public SearchHighlighterBuilder boundaryScannerType(BoundaryScannerType boundaryScannerType)

boundaryScannerLocale

public SearchHighlighterBuilder boundaryScannerLocale(Locale boundaryScannerLocale)

fragmenter

public SearchHighlighterBuilder fragmenter(HighlighterFragmenter type)

phraseLimit

public SearchHighlighterBuilder phraseLimit(Integer phraseLimit)

tag

public SearchHighlighterBuilder tag(String preTag,
                                    String postTag)

tagSchema

public SearchHighlighterBuilder tagSchema(HighlighterTagSchema tagSchema)

encoder

public SearchHighlighterBuilder encoder(HighlighterEncoder encoder)

type
```
public SearchHighlighterType type()
```

boundaryChars
```
public Character[] boundaryChars()
```

boundaryCharsAsString
```
public String boundaryCharsAsString()
```

boundaryMaxScan
```
public Integer boundaryMaxScan()
```

fragmentSize
```
public Integer fragmentSize()
```

noMatchSize
```
public Integer noMatchSize()
```

numberOfFragments
```
public Integer numberOfFragments()
```

orderByScore
```
public Boolean orderByScore()
```

preTags
```
public List<String> preTags()
```

postTags
```
public List<String> postTags()
```

boundaryScannerType

public BoundaryScannerType boundaryScannerType()

boundaryScannerLocale
```
public Locale boundaryScannerLocale()
```

fragmenterType

public HighlighterFragmenter fragmenterType()

phraseLimit
```
public Integer phraseLimit()
```

tagSchema

public HighlighterTagSchema tagSchema()

encoder
```
public HighlighterEncoder encoder()
```

build

public abstract SearchHighlighter build()

Class SearchHighlighterBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

boundaryChars

boundaryMaxScan

fragmentSize

noMatchSize

numberOfFragments

orderByScore

preTags

postTags

boundaryScannerType

boundaryScannerLocale

fragmenterType

phraseLimit

encoder

tagSchema

Constructor Detail

SearchHighlighterBuilder

Method Detail

type

boundaryChars

boundaryChars

boundaryMaxScan

fragmentSize

noMatchSize

numberOfFragments

orderByScore

boundaryScannerType

boundaryScannerLocale

fragmenter

phraseLimit

tag

tags

tags

clearTags

tagSchema

encoder

type

boundaryChars

boundaryCharsAsString

boundaryMaxScan

fragmentSize

noMatchSize

numberOfFragments

orderByScore

preTags

postTags

boundaryScannerType

boundaryScannerLocale

fragmenterType

phraseLimit

tagSchema

encoder

build