org.hkijena.jipipe.api.annotation

Enum JIPipeTextAnnotationMergeMode

java.lang.Object

java.lang.Enum<JIPipeTextAnnotationMergeMode>

org.hkijena.jipipe.api.annotation.JIPipeTextAnnotationMergeMode

All Implemented Interfaces:

Serializable, Comparable<JIPipeTextAnnotationMergeMode>

public enum JIPipeTextAnnotationMergeMode
extends Enum<JIPipeTextAnnotationMergeMode>

Determines how annotations are merged

Enum Constant Summary

Enum Constants

Enum Constant and Description
Discard
Merge
MergeLists
OverwriteExisting
SkipExisting

Method Summary

Modifier and Type	Method and Description
static String[]	extractMergedAnnotations(String merged) Extracts merged annotations
List<JIPipeTextAnnotation>	merge(Collection<JIPipeTextAnnotation> annotations) Ensures that a list of annotations has unique names.
String	merge(String existingValue, String newValue) Merges the new annotation value into the existing one according to the strategy
void	mergeInto(Map<String,JIPipeTextAnnotation> target, Collection<JIPipeTextAnnotation> annotations) Ensures that a list of annotations has unique names.
String	toString()
static JIPipeTextAnnotationMergeMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static JIPipeTextAnnotationMergeMode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SkipExisting

public static final JIPipeTextAnnotationMergeMode SkipExisting

OverwriteExisting

public static final JIPipeTextAnnotationMergeMode OverwriteExisting

Merge

public static final JIPipeTextAnnotationMergeMode Merge

MergeLists

public static final JIPipeTextAnnotationMergeMode MergeLists

Discard

public static final JIPipeTextAnnotationMergeMode Discard

Method Detail

values

public static JIPipeTextAnnotationMergeMode[] 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 (JIPipeTextAnnotationMergeMode c : JIPipeTextAnnotationMergeMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static JIPipeTextAnnotationMergeMode 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

extractMergedAnnotations

public static String[] extractMergedAnnotations(String merged)

Extracts merged annotations

Parameters:

merged - the annotation value

Returns:

the components

merge

public List<JIPipeTextAnnotation> merge(Collection<JIPipeTextAnnotation> annotations)

Ensures that a list of annotations has unique names. Merges according to the strategy if needed.

Parameters:

annotations - input annotations. can have duplicate names.

Returns:

annotations without duplicate names.

mergeInto

public void mergeInto(Map<String,JIPipeTextAnnotation> target,
                      Collection<JIPipeTextAnnotation> annotations)

Ensures that a list of annotations has unique names. Merges according to the strategy if needed. If the mode is Discard, removes all annotations

Parameters:

target - the target list

annotations - input annotations. can have duplicate names.

merge

public String merge(String existingValue,
                    String newValue)

Merges the new annotation value into the existing one according to the strategy

Parameters:

existingValue - the existing value

newValue - the value to be merged

Returns:

the merged result

toString

public String toString()

Overrides:

toString in class Enum<JIPipeTextAnnotationMergeMode>