org.openimaj.ml.annotation

Class AnnotatedObject<OBJECT,ANNOTATION>

java.lang.Object

org.openimaj.ml.annotation.AnnotatedObject<OBJECT,ANNOTATION>

Type Parameters:

OBJECT - Type of object.

ANNOTATION - Type of annotations

All Implemented Interfaces:

Annotated<OBJECT,ANNOTATION>

public class AnnotatedObject<OBJECT,ANNOTATION>
extends Object
implements Annotated<OBJECT,ANNOTATION>

Basic implementation of Annotated.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
Collection<ANNOTATION>	annotations The annotations
OBJECT	object The annotated object

Constructor Summary

Constructors

Constructor and Description
AnnotatedObject(OBJECT object, ANNOTATION annotation) Construct with the given object and its annotation.
AnnotatedObject(OBJECT object, Collection<ANNOTATION> annotations) Construct with the given object and its annotations.

Method Summary

Modifier and Type	Method and Description
static <OBJECT,ANNOTATION> AnnotatedObject<OBJECT,ANNOTATION>	create(OBJECT object, ANNOTATION annotation) Create an AnnotatedObject with the given object and its annotation.
static <OBJECT,ANNOTATION> AnnotatedObject<OBJECT,ANNOTATION>	create(OBJECT object, Collection<ANNOTATION> annotations) Create an AnnotatedObject with the given object and its annotations.
static <OBJECT,ANNOTATION> List<AnnotatedObject<OBJECT,ANNOTATION>>	createList(GroupedDataset<ANNOTATION,? extends ListDataset<OBJECT>,OBJECT> dataset) Convert a grouped dataset to a list of annotated objects.
static <OBJECT,ANNOTATION> List<AnnotatedObject<OBJECT,ANNOTATION>>	createList(OBJECT[] objs, ANNOTATION[] anns) Convert parallel arrays of objects and annotations to a list of AnnotatedObject.
static <OBJECT,ANNOTATION> List<AnnotatedObject<OBJECT,ANNOTATION>>	createList(OBJECT[] objs, ANNOTATION[][] anns) Convert parallel arrays of objects and annotations to a list of AnnotatedObject.
Collection<ANNOTATION>	getAnnotations()
OBJECT	getObject()

Methods inherited from class java.lang.Object

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

Field Detail

object

public OBJECT object

The annotated object

annotations

public Collection<ANNOTATION> annotations

The annotations

Constructor Detail

AnnotatedObject

public AnnotatedObject(OBJECT object,
                       Collection<ANNOTATION> annotations)

Construct with the given object and its annotations.

Parameters:

object - the object

annotations - the objects annotations.

AnnotatedObject

public AnnotatedObject(OBJECT object,
                       ANNOTATION annotation)

Construct with the given object and its annotation.

Parameters:

object - the object

annotation - the object's annotation.

Method Detail

getObject

public OBJECT getObject()

Specified by:

getObject in interface Annotated<OBJECT,ANNOTATION>

Returns:

the object

getAnnotations

public Collection<ANNOTATION> getAnnotations()

Specified by:

getAnnotations in interface Annotated<OBJECT,ANNOTATION>

Returns:

the annotations

create

public static <OBJECT,ANNOTATION> AnnotatedObject<OBJECT,ANNOTATION> create(OBJECT object,
                                                                            Collection<ANNOTATION> annotations)

Create an AnnotatedObject with the given object and its annotations.

Type Parameters:

OBJECT - Type of object.

ANNOTATION - Type of annotations

Parameters:

object - the object

annotations - the objects annotations.

Returns:

the new AnnotatedObject

create

public static <OBJECT,ANNOTATION> AnnotatedObject<OBJECT,ANNOTATION> create(OBJECT object,
                                                                            ANNOTATION annotation)

Create an AnnotatedObject with the given object and its annotation.

Type Parameters:

OBJECT - Type of object.

ANNOTATION - Type of annotations

Parameters:

object - the object

annotation - the object's annotation.

Returns:

the new AnnotatedObject

createList

public static <OBJECT,ANNOTATION> List<AnnotatedObject<OBJECT,ANNOTATION>> createList(GroupedDataset<ANNOTATION,? extends ListDataset<OBJECT>,OBJECT> dataset)

Convert a grouped dataset to a list of annotated objects. The annotations correspond to the type of group. If the same object appears in multiple groups within the dataset then it will have multiple annotations.

Type Parameters:

OBJECT - Type of object.

ANNOTATION - Type of annotations.

Parameters:

dataset - the dataset

Returns:

the list of annotated instances

createList

public static <OBJECT,ANNOTATION> List<AnnotatedObject<OBJECT,ANNOTATION>> createList(OBJECT[] objs,
                                                                                      ANNOTATION[] anns)

Convert parallel arrays of objects and annotations to a list of AnnotatedObject.

Parameters:

objs - the objects

anns - the annotation for each object (assumes 1 annotation per object).

Returns:

the list

createList

public static <OBJECT,ANNOTATION> List<AnnotatedObject<OBJECT,ANNOTATION>> createList(OBJECT[] objs,
                                                                                      ANNOTATION[][] anns)

Convert parallel arrays of objects and annotations to a list of AnnotatedObject.

Parameters:

objs - the objects

anns - the annotations for each object.

Returns:

the list