Package org.hibernate.search.backend.elasticsearch.index.layout.impl

Class IndexNames

java.lang.Object

org.hibernate.search.backend.elasticsearch.index.layout.impl.IndexNames

public final class IndexNames
extends Object

Constructor Summary

Constructors

Constructor	Description
IndexNames(String hibernateSearch, URLEncodedString write, boolean writeIsAlias, URLEncodedString read, boolean readIsAlias)

Method Summary

Modifier and Type	Method	Description
static URLEncodedString	encodeName(String name)
String	hibernateSearchIndex()
static String	normalizeName(String indexName)
URLEncodedString	read()
boolean	readIsAlias()
String	toString()
URLEncodedString	write()
boolean	writeIsAlias()

Methods inherited from class java.lang.Object

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

Constructor Details

IndexNames

public IndexNames(String hibernateSearch,
 URLEncodedString write,
 boolean writeIsAlias,
 URLEncodedString read,
 boolean readIsAlias)

Method Details

normalizeName

public static String normalizeName(String indexName)

encodeName

public static URLEncodedString encodeName(String name)

toString

public String toString()

Overrides:

toString in class Object

hibernateSearchIndex

public String hibernateSearchIndex()

Returns:

The Hibernate Search index name, i.e. the name that Hibernate Search uses internally to designate that index, for example in configuration files.

write

public URLEncodedString write()

Returns:

The write name, i.e. the name that Hibernate Search is supposed to use when indexing or purging the index.

writeIsAlias

public boolean writeIsAlias()

Returns:

Whether the write name is an alias (true) or not (false).

read

public URLEncodedString read()

Returns:

The read name, i.e. the name that Hibernate Search is supposed to use when executing searches on the index.

readIsAlias

public boolean readIsAlias()

Returns:

Whether the write name is an alias (true) or not (false).