View (org.lappsgrid:serialization:2.7.0)

org.lappsgrid.serialization.lif.View

A View consists of some metadata and a list of annotations.
Each LAPPS processing service will generally place the annotations it generates in its own View object. This makes it easier to determine the annotations produces by each processor and to quickly extract that subset of annotations.
However, the concept of a View is meant to be very generic and can contain any arbitrary collection of annotations grouped with arbitrary metadata.
Authors:
Keith Suderman

Properties Summary

Properties
Type	Name and description
`List<Annotation>`	`annotations` The annotations that belong to this processing step.
`String`	`id` A unique ID value for this view.
`Map`	`metadata` User defined metadata for this processing step.

Constructor Summary

Constructors
Constructor and description
`View ()`
`View (String id)`
`View (Map map)`
`View (View view)`

Methods Summary

Methods
Type	Name and description
`void`	`add(Annotation annotation)` Adds an annotation to the processing step's list of annotations.
`void`	`addAnnotation(Annotation annotation)` Adds an annotation to the processing step's list of annotations.
`Contains`	`addContains(String name, String producer, String type)` Adds an entry to the contains section in the view object.
`void`	`addMetaData(String name, Object value)` Adds the name/value pair to the metadata map.
`boolean`	`contains(String name)` Returns true if the metadata.contains map contains the named key.
`List<Annotation>`	`findByAtType(String type)`
`Annotation`	`findById(String id)`
`Contains`	`getContains(String name)`
`Object`	`getMetaData(String name)`
`String`	`getTimestamp()`
`Annotation`	`newAnnotation()` Creates and returns a new Annotation.
`Annotation`	`newAnnotation(String id, String type, long start = -1, long end = -1)` Creates and returns a new Annotation.
`void`	`setTimestamp()`
`void`	`setTimestamp(String time)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - List<Annotation> annotations
    
    The annotations that belong to this processing step.
  - String id
    
    A unique ID value for this view.
  - Map metadata
    
    User defined metadata for this processing step.
- Constructor Detail
  - View()
  - View(String id)
  - View(Map map)
  - View(View view)
- Method Detail
  - void add(Annotation annotation)
    
    Adds an annotation to the processing step's list of annotations.
  - void addAnnotation(Annotation annotation)
    
    Adds an annotation to the processing step's list of annotations.
  - Contains addContains(String name, String producer, String type)
    
    Adds an entry to the contains section in the view object.
    Parameters:
    name - The URI of the annotation type being created.
    producer - The tool or program that generated the view.
    type - The annotation type. Currently this field is under-defined.
  - void addMetaData(String name, Object value)
    
    Adds the name/value pair to the metadata map.
  - boolean contains(String name)
    
    Returns true if the metadata.contains map contains the named key. Returns false otherwise. \
  - List<Annotation> findByAtType(String type)
  - Annotation findById(String id)
  - Contains getContains(String name)
  - Object getMetaData(String name)
  - @JsonIgnore String getTimestamp()
  - Annotation newAnnotation()
    
    Creates and returns a new Annotation.
  - Annotation newAnnotation(String id, String type, long start = -1, long end = -1)
    
    Creates and returns a new Annotation.
  - void setTimestamp()
  - void setTimestamp(String time)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

org.lappsgrid:serialization:2.7.0

[Groovy] Class View

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

List<Annotation> annotations

String id

Map metadata

Constructor Detail

View()

View(String id)

View(Map map)

View(View view)

Method Detail

void add(Annotation annotation)

void addAnnotation(Annotation annotation)

Contains addContains(String name, String producer, String type)

void addMetaData(String name, Object value)

boolean contains(String name)

List<Annotation> findByAtType(String type)

Annotation findById(String id)

Contains getContains(String name)

Object getMetaData(String name)

@JsonIgnore String getTimestamp()

Annotation newAnnotation()

Annotation newAnnotation(String id, String type, long start = -1, long end = -1)

void setTimestamp()

void setTimestamp(String time)