Package com.levigo.jadice.server.documentplatform

Enum ReshapeNode.OutputMode

java.lang.Object

java.lang.Enum<ReshapeNode.OutputMode>

com.levigo.jadice.server.documentplatform.ReshapeNode.OutputMode

All Implemented Interfaces:

Serializable, Comparable<ReshapeNode.OutputMode>

Enclosing class:

ReshapeNode

public static enum ReshapeNode.OutputMode
extends Enum<ReshapeNode.OutputMode>

Enum controlling when and how output data streams are generated.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSOCIATED_JOINED	Generate one stream in total by layering associated atop of each other, disjoint streams after another.
ASSOCIATED_STREAM	Generate one stream per parent stream by layering associated streams atop of each other.
JOINED	Generate one stream in total by joining all incoming documents together.
LAYERED	Generate one stream in total by layering all incoming documents atop of each other.
PAGE	Generate one stream per page, i.e.
STREAM	Generate one stream per incoming stream.

Method Summary

Modifier and Type	Method	Description
static ReshapeNode.OutputMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ReshapeNode.OutputMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PAGE

public static final ReshapeNode.OutputMode PAGE

Generate one stream per page, i.e. single-page TIFFs

STREAM

public static final ReshapeNode.OutputMode STREAM

Generate one stream per incoming stream.

JOINED

public static final ReshapeNode.OutputMode JOINED

Generate one stream in total by joining all incoming documents together.

LAYERED

public static final ReshapeNode.OutputMode LAYERED

Generate one stream in total by layering all incoming documents atop of each other.

ASSOCIATED_JOINED

public static final ReshapeNode.OutputMode ASSOCIATED_JOINED

Generate one stream in total by layering associated atop of each other, disjoint streams after another. A document is considered associated with another document if the former is a parent of the latter. Associated streams must always be supplied after their respective parent.

See Also:

StreamDescriptor.getParent()

ASSOCIATED_STREAM

public static final ReshapeNode.OutputMode ASSOCIATED_STREAM

Generate one stream per parent stream by layering associated streams atop of each other. A document is considered associated with another document if the former is a parent of the latter. Associated streams must always be supplied after their respective parent.

See Also:

StreamDescriptor.getParent()

Method Detail

values

public static ReshapeNode.OutputMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReshapeNode.OutputMode c : ReshapeNode.OutputMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReshapeNode.OutputMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null