com.exalead.mercury.mami.deploy.v10

Class ContiguousDidAllocationPolicy

java.lang.Object

com.exalead.mercury.mami.deploy.v10.DidAllocationPolicy

com.exalead.mercury.mami.deploy.v10.ContiguousDidAllocationPolicy

All Implemented Interfaces:

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

public class ContiguousDidAllocationPolicy
extends DidAllocationPolicy
implements com.exalead.util.Checkable, java.io.Serializable

Base-class specifying how DIDs (Document IDs) are assigned to the documents.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.deploy.v10.DidAllocationPolicy

DidAllocationPolicy.Transformer<T>, DidAllocationPolicy.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_INCREASING
static int	DEFAULT_STARTING_POINT
java.lang.Integer	endingPoint
boolean	increasing
int	startingPoint

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DidAllocationPolicy.Transformer<T> transformer, T[] t)
void	accept(DidAllocationPolicy.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this ContiguousDidAllocationPolicy.
static ContiguousDidAllocationPolicy	fromString(java.lang.String s) String representation of this ContiguousDidAllocationPolicy.
java.lang.Integer	getEndingPoint() End point of the allocation.
int	getStartingPoint() Start point of the allocation.
boolean	isIncreasing() Assign DIDs in an increasing order.
ContiguousDidAllocationPolicy	makeCopy() Creates and returns a deep copy of this ContiguousDidAllocationPolicy.
static ContiguousDidAllocationPolicy	readFrom(java.io.InputStream is) Read this ContiguousDidAllocationPolicy from an XML fragment.
void	setEndingPoint(java.lang.Integer endingPoint) End point of the allocation.
void	setIncreasing(boolean increasing) Assign DIDs in an increasing order.
void	setStartingPoint(int startingPoint) Start point of the allocation.
java.lang.String	toString() String representation of this ContiguousDidAllocationPolicy.
ContiguousDidAllocationPolicy	withEndingPoint(java.lang.Integer endingPoint)
ContiguousDidAllocationPolicy	withIncreasing(boolean increasing)
ContiguousDidAllocationPolicy	withIncreasing(java.lang.Boolean increasing)
ContiguousDidAllocationPolicy	withStartingPoint(int startingPoint)
ContiguousDidAllocationPolicy	withStartingPoint(java.lang.Integer startingPoint)
void	writeTo(java.io.OutputStream os) Write this ContiguousDidAllocationPolicy as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

increasing

public boolean increasing

DEFAULT_INCREASING

public static final boolean DEFAULT_INCREASING

See Also:

Constant Field Values

startingPoint

public int startingPoint

DEFAULT_STARTING_POINT

public static final int DEFAULT_STARTING_POINT

See Also:

Constant Field Values

endingPoint

public java.lang.Integer endingPoint

Constructor Detail

ContiguousDidAllocationPolicy

public ContiguousDidAllocationPolicy()

ContiguousDidAllocationPolicy

public ContiguousDidAllocationPolicy(ContiguousDidAllocationPolicy o)

Copy constructor

Method Detail

setIncreasing

public void setIncreasing(boolean increasing)

Assign DIDs in an increasing order.

isIncreasing

public boolean isIncreasing()

Assign DIDs in an increasing order.

withIncreasing

public ContiguousDidAllocationPolicy withIncreasing(boolean increasing)

withIncreasing

public ContiguousDidAllocationPolicy withIncreasing(java.lang.Boolean increasing)

setStartingPoint

public void setStartingPoint(int startingPoint)

Start point of the allocation. By default, the first DID will have value '1'.

getStartingPoint

public int getStartingPoint()

Start point of the allocation. By default, the first DID will have value '1'.

withStartingPoint

public ContiguousDidAllocationPolicy withStartingPoint(int startingPoint)

withStartingPoint

public ContiguousDidAllocationPolicy withStartingPoint(java.lang.Integer startingPoint)

setEndingPoint

public void setEndingPoint(java.lang.Integer endingPoint)

End point of the allocation. By default, it will be Integer.MAX_VALUE if increasing or 1 if decreasing.

getEndingPoint

public java.lang.Integer getEndingPoint()

End point of the allocation. By default, it will be Integer.MAX_VALUE if increasing or 1 if decreasing.

withEndingPoint

public ContiguousDidAllocationPolicy withEndingPoint(java.lang.Integer endingPoint)

makeCopy

public ContiguousDidAllocationPolicy makeCopy()

Creates and returns a deep copy of this ContiguousDidAllocationPolicy.

Overrides:

makeCopy in class DidAllocationPolicy

readFrom

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

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

Overrides:

writeTo in class DidAllocationPolicy

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ContiguousDidAllocationPolicy.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ContiguousDidAllocationPolicy.

Overrides:

toString in class DidAllocationPolicy

check

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

Checks this ContiguousDidAllocationPolicy.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DidAllocationPolicy

Throws:

com.exalead.util.TypedException

accept

public void accept(DidAllocationPolicy.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class DidAllocationPolicy

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(DidAllocationPolicy.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class DidAllocationPolicy

Throws:

com.exalead.util.TypedException