com.exalead.mercury.mami.deploy.v10

Class BuildGroupConfig

java.lang.Object

com.exalead.mercury.mami.deploy.v10.BuildGroupConfig

All Implemented Interfaces:

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

public class BuildGroupConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Configuration of a build group.
A "Build Group" is defined by references to sub-configurations defined in other MAMI:

• Analysis (how documents are processed).
• Index Builder (how indexing jobs are scheduled and managed).
• Index Schema (schema of the index slices being built).
• Task Queue (how input document processing tasks are queued before jobs).
• Similar Document (optional)

Several build groups may share some or all their sub-configuration. In most configuration, all build groups would share the same index schema configuration.
When built with the same schema, index slices built by different build groups can be queried together (see the Search MAMI).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	buildGroup
java.lang.String	dataModel
DidAllocationPolicy	didAllocationPolicy
DIHConfig	dIHConfig
DocumentCacheConfig	documentCacheConfig
java.lang.String	indexingConfig
PrecomputedThumbnailsConfig	precomputedThumbnailsConfig
java.util.List<ScratchHook>	scratchHook
SlicePartioningPolicy	slicePartioningPolicy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this BuildGroupConfig.
static BuildGroupConfig	fromString(java.lang.String s) String representation of this BuildGroupConfig.
java.lang.String	getBuildGroup() Name of the build group.
java.lang.String	getDataModel() Name of the data model.
DidAllocationPolicy	getDidAllocationPolicy()
DIHConfig	getDIHConfig()
DocumentCacheConfig	getDocumentCacheConfig()
java.lang.String	getIndexingConfig() Name of an indexing configuration (IndexingConfig element in Indexing MAMI).
PrecomputedThumbnailsConfig	getPrecomputedThumbnailsConfig()
java.util.List<ScratchHook>	getScratchHook() Deprecated.
SlicePartioningPolicy	getSlicePartioningPolicy()
BuildGroupConfig	makeCopy() Creates and returns a deep copy of this BuildGroupConfig.
static BuildGroupConfig	readFrom(java.io.InputStream is) Read this BuildGroupConfig from an XML fragment.
void	setBuildGroup(java.lang.String buildGroup) Name of the build group.
void	setDataModel(java.lang.String dataModel) Name of the data model.
void	setDidAllocationPolicy(DidAllocationPolicy didAllocationPolicy)
void	setDIHConfig(DIHConfig dIHConfig)
void	setDocumentCacheConfig(DocumentCacheConfig documentCacheConfig)
void	setIndexingConfig(java.lang.String indexingConfig) Name of an indexing configuration (IndexingConfig element in Indexing MAMI).
void	setPrecomputedThumbnailsConfig(PrecomputedThumbnailsConfig precomputedThumbnailsConfig)
void	setSlicePartioningPolicy(SlicePartioningPolicy slicePartioningPolicy)
java.lang.String	toString() String representation of this BuildGroupConfig.
BuildGroupConfig	withBuildGroup(java.lang.String buildGroup)
BuildGroupConfig	withDataModel(java.lang.String dataModel)
BuildGroupConfig	withDidAllocationPolicy(DidAllocationPolicy didAllocationPolicy)
BuildGroupConfig	withDIHConfig(DIHConfig dIHConfig)
BuildGroupConfig	withDocumentCacheConfig(DocumentCacheConfig documentCacheConfig)
BuildGroupConfig	withIndexingConfig(java.lang.String indexingConfig)
BuildGroupConfig	withPrecomputedThumbnailsConfig(PrecomputedThumbnailsConfig precomputedThumbnailsConfig)
BuildGroupConfig	withScratchHook(java.util.Collection<ScratchHook> __values)
BuildGroupConfig	withScratchHook(ScratchHook... __values) Deprecated.
BuildGroupConfig	withSlicePartioningPolicy(SlicePartioningPolicy slicePartioningPolicy)
void	writeTo(java.io.OutputStream os) Write this BuildGroupConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

scratchHook

public java.util.List<ScratchHook> scratchHook

documentCacheConfig

public DocumentCacheConfig documentCacheConfig

dIHConfig

public DIHConfig dIHConfig

slicePartioningPolicy

public SlicePartioningPolicy slicePartioningPolicy

didAllocationPolicy

public DidAllocationPolicy didAllocationPolicy

precomputedThumbnailsConfig

public PrecomputedThumbnailsConfig precomputedThumbnailsConfig

buildGroup

public java.lang.String buildGroup

dataModel

public java.lang.String dataModel

indexingConfig

public java.lang.String indexingConfig

Constructor Detail

BuildGroupConfig

public BuildGroupConfig()

BuildGroupConfig

public BuildGroupConfig(BuildGroupConfig o)

Copy constructor

Method Detail

getScratchHook

@Deprecated
public java.util.List<ScratchHook> getScratchHook()

Deprecated.

withScratchHook

@Deprecated
public BuildGroupConfig withScratchHook(ScratchHook... __values)

Deprecated.

withScratchHook

public BuildGroupConfig withScratchHook(java.util.Collection<ScratchHook> __values)

setDocumentCacheConfig

public void setDocumentCacheConfig(DocumentCacheConfig documentCacheConfig)

getDocumentCacheConfig

public DocumentCacheConfig getDocumentCacheConfig()

withDocumentCacheConfig

public BuildGroupConfig withDocumentCacheConfig(DocumentCacheConfig documentCacheConfig)

setDIHConfig

public void setDIHConfig(DIHConfig dIHConfig)

getDIHConfig

public DIHConfig getDIHConfig()

withDIHConfig

public BuildGroupConfig withDIHConfig(DIHConfig dIHConfig)

setSlicePartioningPolicy

public void setSlicePartioningPolicy(SlicePartioningPolicy slicePartioningPolicy)

getSlicePartioningPolicy

public SlicePartioningPolicy getSlicePartioningPolicy()

withSlicePartioningPolicy

public BuildGroupConfig withSlicePartioningPolicy(SlicePartioningPolicy slicePartioningPolicy)

setDidAllocationPolicy

public void setDidAllocationPolicy(DidAllocationPolicy didAllocationPolicy)

getDidAllocationPolicy

public DidAllocationPolicy getDidAllocationPolicy()

withDidAllocationPolicy

public BuildGroupConfig withDidAllocationPolicy(DidAllocationPolicy didAllocationPolicy)

setPrecomputedThumbnailsConfig

public void setPrecomputedThumbnailsConfig(PrecomputedThumbnailsConfig precomputedThumbnailsConfig)

getPrecomputedThumbnailsConfig

public PrecomputedThumbnailsConfig getPrecomputedThumbnailsConfig()

withPrecomputedThumbnailsConfig

public BuildGroupConfig withPrecomputedThumbnailsConfig(PrecomputedThumbnailsConfig precomputedThumbnailsConfig)

setBuildGroup

public void setBuildGroup(java.lang.String buildGroup)

Name of the build group. This name should be unique.

getBuildGroup

public java.lang.String getBuildGroup()

Name of the build group. This name should be unique.

withBuildGroup

public BuildGroupConfig withBuildGroup(java.lang.String buildGroup)

setDataModel

public void setDataModel(java.lang.String dataModel)

Name of the data model.

getDataModel

public java.lang.String getDataModel()

Name of the data model.

withDataModel

public BuildGroupConfig withDataModel(java.lang.String dataModel)

setIndexingConfig

public void setIndexingConfig(java.lang.String indexingConfig)

Name of an indexing configuration (IndexingConfig element in Indexing MAMI).

getIndexingConfig

public java.lang.String getIndexingConfig()

Name of an indexing configuration (IndexingConfig element in Indexing MAMI).

withIndexingConfig

public BuildGroupConfig withIndexingConfig(java.lang.String indexingConfig)

makeCopy

public BuildGroupConfig makeCopy()

Creates and returns a deep copy of this BuildGroupConfig.

readFrom

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

Read this BuildGroupConfig 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 BuildGroupConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this BuildGroupConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this BuildGroupConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this BuildGroupConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException