com.exalead.mercury.mami.indexing.v10

Class StandardIndexManagementPolicy

java.lang.Object

com.exalead.mercury.mami.indexing.v10.IndexManagementPolicy

com.exalead.mercury.mami.indexing.v10.StandardIndexManagementPolicy

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class StandardIndexManagementPolicy
extends IndexManagementPolicy
implements com.exalead.util.Checkable, java.io.Serializable

Default index (service + build) runtime configuration

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
CommitPolicy	commitPolicy
CompactPolicies	compactPolicies
static int	DEFAULT_GC_EVERY_S
int	gcEveryS
UploadPolicy	uploadPolicy

Constructor Summary

Constructors

Constructor and Description
StandardIndexManagementPolicy()
StandardIndexManagementPolicy(StandardIndexManagementPolicy o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this StandardIndexManagementPolicy.
static StandardIndexManagementPolicy	fromString(java.lang.String s) String representation of this StandardIndexManagementPolicy.
CommitPolicy	getCommitPolicy() The commit policy used to configured how the index persists its file to disk.
CompactPolicies	getCompactPolicies() The compact policies used to trigger slots compaction.
int	getGcEveryS() Trigger a GC every N seconds.
UploadPolicy	getUploadPolicy() The upload policy used to replicate new slots to replicas.
StandardIndexManagementPolicy	makeCopy() Creates and returns a deep copy of this StandardIndexManagementPolicy.
static StandardIndexManagementPolicy	readFrom(java.io.InputStream is) Read this StandardIndexManagementPolicy from an XML fragment.
void	setCommitPolicy(CommitPolicy commitPolicy) The commit policy used to configured how the index persists its file to disk.
void	setCompactPolicies(CompactPolicies compactPolicies) The compact policies used to trigger slots compaction.
void	setGcEveryS(int gcEveryS) Trigger a GC every N seconds.
void	setUploadPolicy(UploadPolicy uploadPolicy) The upload policy used to replicate new slots to replicas.
java.lang.String	toString() String representation of this StandardIndexManagementPolicy.
StandardIndexManagementPolicy	withCommitPolicy(CommitPolicy commitPolicy)
StandardIndexManagementPolicy	withCompactPolicies(CompactPolicies compactPolicies)
StandardIndexManagementPolicy	withGcEveryS(int gcEveryS)
StandardIndexManagementPolicy	withGcEveryS(java.lang.Integer gcEveryS)
StandardIndexManagementPolicy	withUploadPolicy(UploadPolicy uploadPolicy)
void	writeTo(java.io.OutputStream os) Write this StandardIndexManagementPolicy as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

gcEveryS

public int gcEveryS

DEFAULT_GC_EVERY_S

public static final int DEFAULT_GC_EVERY_S

See Also:

Constant Field Values

compactPolicies

public CompactPolicies compactPolicies

uploadPolicy

public UploadPolicy uploadPolicy

commitPolicy

public CommitPolicy commitPolicy

Constructor Detail

StandardIndexManagementPolicy

public StandardIndexManagementPolicy()

StandardIndexManagementPolicy

public StandardIndexManagementPolicy(StandardIndexManagementPolicy o)

Copy constructor

Method Detail

setGcEveryS

public void setGcEveryS(int gcEveryS)

Trigger a GC every N seconds.

getGcEveryS

public int getGcEveryS()

Trigger a GC every N seconds.

withGcEveryS

public StandardIndexManagementPolicy withGcEveryS(int gcEveryS)

withGcEveryS

public StandardIndexManagementPolicy withGcEveryS(java.lang.Integer gcEveryS)

setCompactPolicies

public void setCompactPolicies(CompactPolicies compactPolicies)

The compact policies used to trigger slots compaction.

getCompactPolicies

public CompactPolicies getCompactPolicies()

The compact policies used to trigger slots compaction.

withCompactPolicies

public StandardIndexManagementPolicy withCompactPolicies(CompactPolicies compactPolicies)

setUploadPolicy

public void setUploadPolicy(UploadPolicy uploadPolicy)

The upload policy used to replicate new slots to replicas.

getUploadPolicy

public UploadPolicy getUploadPolicy()

The upload policy used to replicate new slots to replicas.

withUploadPolicy

public StandardIndexManagementPolicy withUploadPolicy(UploadPolicy uploadPolicy)

setCommitPolicy

public void setCommitPolicy(CommitPolicy commitPolicy)

The commit policy used to configured how the index persists its file to disk.

getCommitPolicy

public CommitPolicy getCommitPolicy()

The commit policy used to configured how the index persists its file to disk.

withCommitPolicy

public StandardIndexManagementPolicy withCommitPolicy(CommitPolicy commitPolicy)

makeCopy

public StandardIndexManagementPolicy makeCopy()

Creates and returns a deep copy of this StandardIndexManagementPolicy.

Overrides:

makeCopy in class IndexManagementPolicy

readFrom

public static StandardIndexManagementPolicy readFrom(java.io.InputStream is)
                                              throws javax.xml.bind.JAXBException

Read this StandardIndexManagementPolicy from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this StandardIndexManagementPolicy as an XML fragment

Overrides:

writeTo in class IndexManagementPolicy

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static StandardIndexManagementPolicy fromString(java.lang.String s)
                                                throws javax.xml.bind.JAXBException,
                                                       java.io.UnsupportedEncodingException

String representation of this StandardIndexManagementPolicy.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this StandardIndexManagementPolicy.

Overrides:

toString in class IndexManagementPolicy

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this StandardIndexManagementPolicy.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexManagementPolicy

Throws:

com.exalead.util.TypedException