JIPipeTextAnnotation (jipipe 1.76.1-SNAPSHOT API)

java.lang.Object
- org.hkijena.jipipe.api.annotation.JIPipeTextAnnotation

All Implemented Interfaces:: Comparable<JIPipeTextAnnotation>, JIPipeAnnotation

public class JIPipeTextAnnotation
extends Object
implements Comparable<JIPipeTextAnnotation>, JIPipeAnnotation

A single annotation

Constructor Summary

Constructors
Constructor and Description
`JIPipeTextAnnotation()` Creates an empty instance
`JIPipeTextAnnotation(String name, Collection<String> values)` Creates a new instance from an array.
`JIPipeTextAnnotation(String name, String value)` Initializes a new instance
`JIPipeTextAnnotation(String name, String[] values)` Creates a new instance from an array.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Map<String,String>`	`annotationListToMap(Collection<JIPipeTextAnnotation> annotations, JIPipeTextAnnotationMergeMode mergeStrategy)` Converts a set of annotations to a map
`static org.python.core.PyDictionary`	`annotationListToPython(Collection<JIPipeTextAnnotation> annotations)` Converts a list of annotations into a Python dictionary
`static org.python.core.PyDictionary`	`annotationMapToPython(Map<String,JIPipeTextAnnotation> annotationMap)` Converts a map of annotations into a Python dictionary
`int`	`compareTo(JIPipeTextAnnotation o)`
`boolean`	`equals(Object o)` Returns true if the name and value are equal
`static List<JIPipeTextAnnotation>`	`extractAnnotationsFromPython(org.python.core.PyDictionary annotationDict)` Sets annotations from a Python dictionary
`String[]`	`getArray()` Returns the value as array or an array with the value if it is not an array.
`String`	`getName()`
`String`	`getValue()`
`int`	`hashCode()`
`boolean`	`isArray()` Returns true if the value is an array
`static List<JIPipeTextAnnotation>`	`mapToAnnotationList(Map<String,String> map)` Converts an annotation map to a list
`boolean`	`nameEquals(JIPipeTextAnnotation other)` Returns true if the names are equal
`static boolean`	`nameEquals(JIPipeTextAnnotation lhs, JIPipeTextAnnotation rhs)` Returns true if both have the same name.
`boolean`	`nameEquals(String name)` Returns true if the name equals the string
`static void`	`setAnnotationsFromPython(org.python.core.PyDictionary annotationDict, Map<String,JIPipeTextAnnotation> target)` Sets annotations from a Python dictionary
`void`	`setName(String name)`
`void`	`setValue(String value)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JIPipeTextAnnotation
```
public JIPipeTextAnnotation()
```
    Creates an empty instance
  - JIPipeTextAnnotation
```
public JIPipeTextAnnotation(String name,
                            String value)
```
    Initializes a new instance
    
    Parameters:
    
    name - the name
    
    value - the value
  - JIPipeTextAnnotation
```
public JIPipeTextAnnotation(String name,
                            Collection<String> values)
```
    Creates a new instance from an array. Automatically collapses the array if it contains only one item. If the array is empty, the value is empty. The array is converted into JSON
    
    Parameters:
    
    name - the name
    
    values - the values
  - JIPipeTextAnnotation
```
public JIPipeTextAnnotation(String name,
                            String[] values)
```
    Creates a new instance from an array. Automatically collapses the array if it contains only one item. If the array is empty, the value is empty. The array is converted into JSON
    
    Parameters:
    
    name - the name
    
    values - the values
- Method Detail
  - nameEquals
```
public static boolean nameEquals(JIPipeTextAnnotation lhs,
                                 JIPipeTextAnnotation rhs)
```
    Returns true if both have the same name. Returns false if either are null
    
    Parameters:
    
    lhs - the first
    
    rhs - the second
    
    Returns:
    
    if both have the same name and are not null
  - annotationMapToPython
```
public static org.python.core.PyDictionary annotationMapToPython(Map<String,JIPipeTextAnnotation> annotationMap)
```
    Converts a map of annotations into a Python dictionary
    
    Parameters:
    
    annotationMap - the annotations
    
    Returns:
    
    the Python dictionary
  - setAnnotationsFromPython
```
public static void setAnnotationsFromPython(org.python.core.PyDictionary annotationDict,
                                            Map<String,JIPipeTextAnnotation> target)
```
    Sets annotations from a Python dictionary
    
    Parameters:
    
    annotationDict - the dictionary
    
    target - the target map
  - extractAnnotationsFromPython
```
public static List<JIPipeTextAnnotation> extractAnnotationsFromPython(org.python.core.PyDictionary annotationDict)
```
    Sets annotations from a Python dictionary
    
    Parameters:
    
    annotationDict - the dictionary
  - annotationListToPython
```
public static org.python.core.PyDictionary annotationListToPython(Collection<JIPipeTextAnnotation> annotations)
```
    Converts a list of annotations into a Python dictionary
    
    Parameters:
    
    annotations - the annotations
    
    Returns:
    
    the Python dictionary
  - annotationListToMap
```
public static Map<String,String> annotationListToMap(Collection<JIPipeTextAnnotation> annotations,
                                                     JIPipeTextAnnotationMergeMode mergeStrategy)
```
    Converts a set of annotations to a map
    
    Parameters:
    
    annotations - the annotations
    
    Returns:
    
    annotations as map
  - mapToAnnotationList
```
public static List<JIPipeTextAnnotation> mapToAnnotationList(Map<String,String> map)
```
    Converts an annotation map to a list
    
    Parameters:
    
    map - the map
    
    Returns:
    
    the annotations
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface JIPipeAnnotation
  - setName
```
public void setName(String name)
```
  - getValue
```
public String getValue()
```
  - setValue
```
public void setValue(String value)
```
  - getArray
```
public String[] getArray()
```
    Returns the value as array or an array with the value if it is not an array.
    
    Returns:
    
    the value inside an array or the value as array
  - compareTo
```
public int compareTo(JIPipeTextAnnotation o)
```
    Specified by:
    
    compareTo in interface Comparable<JIPipeTextAnnotation>
  - equals
```
public boolean equals(Object o)
```
    Returns true if the name and value are equal
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the other
    
    Returns:
    
    if the name and value are equal
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - nameEquals
```
public boolean nameEquals(JIPipeTextAnnotation other)
```
    Returns true if the names are equal
    
    Parameters:
    
    other - the other
    
    Returns:
    
    if the names are equal
  - nameEquals
```
public boolean nameEquals(String name)
```
    Returns true if the name equals the string
    
    Parameters:
    
    name - the string
    
    Returns:
    
    if the name equals the string
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isArray
```
public boolean isArray()
```
    Returns true if the value is an array
    
    Returns:
    
    if the value is an array

Class JIPipeTextAnnotation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JIPipeTextAnnotation

JIPipeTextAnnotation

JIPipeTextAnnotation

JIPipeTextAnnotation

Method Detail

nameEquals

annotationMapToPython

setAnnotationsFromPython

extractAnnotationsFromPython

annotationListToPython

annotationListToMap

mapToAnnotationList

getName

setName

getValue

setValue

getArray

compareTo

equals

hashCode

nameEquals

nameEquals

toString

isArray