it.uniroma2.sag.kelp.data.example

Class SimpleExample

java.lang.Object

it.uniroma2.sag.kelp.data.example.Example

it.uniroma2.sag.kelp.data.example.SimpleExample

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ExamplePair, SequenceExample

public class SimpleExample
extends Example

An Example composed by a set of Representations.

Author:

Simone Filice

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
SimpleExample() Initializes an empty example (0 labels and 0 representations)
SimpleExample(Label[] labels, HashMap<String,Representation> representations) Initializes a SimpleExample with the input representations and labels

Method Summary

Methods

Modifier and Type	Method and Description
void	addRepresentation(String representationName, Representation representation) Adds a representation to this example
boolean	equals(Object example)
boolean	equalsIgnoreLabels(SimpleExample example) Asserts whether this example and the input one have identical representations, ignoring their labels
int	getNumberOfRepresentations() Returns the number of representations in which this example is modeled
Representation	getRepresentation(String representationName) Returns the representation corresponding to representationName
Map<String,Representation>	getRepresentations() Returns the example representations
boolean	isCompatible(Example example) Evaluates whether an example is compatible with this one, i.e., they have the same structure in terms of Example type and representations
void	manipulate(Manipulator manipulator) Manipulate this example accordingly to the provided manipulator
String	printExample(String... representations)
void	setRepresentations(HashMap<String,Representation> representations) Sets the example representations
String	toString()

Methods inherited from class it.uniroma2.sag.kelp.data.example.Example

addLabel, duplicate, getClassificationLabels, getId, getLabels, getNumberOfClassificationLabels, getNumberOfRegressionLabels, getRegressionLabels, getRegressionValue, getRegressionValues, getTextualLabelPart, isExampleOf, setClassificationLabels, setLabels, setRegressionValues

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected org.slf4j.Logger logger

Constructor Detail

SimpleExample

public SimpleExample()

Initializes an empty example (0 labels and 0 representations)

SimpleExample

public SimpleExample(Label[] labels,
             HashMap<String,Representation> representations)

Initializes a SimpleExample with the input representations and labels

Parameters:

labels - the classes whose this instance is a positive example

representations - the various representations in which the instance is represented

Method Detail

setRepresentations

public void setRepresentations(HashMap<String,Representation> representations)

Description copied from class: Example

Sets the example representations

Specified by:

setRepresentations in class Example

Parameters:

representations - to associate to this example

getRepresentations

public Map<String,Representation> getRepresentations()

Description copied from class: Example

Returns the example representations

Specified by:

getRepresentations in class Example

Returns:

the representations of this example

addRepresentation

public void addRepresentation(String representationName,
                     Representation representation)

Description copied from class: Example

Adds a representation to this example

Specified by:

addRepresentation in class Example

Parameters:

representationName - the identifier of the representation to be added

representation - the representation to be added

getNumberOfRepresentations

public int getNumberOfRepresentations()

Description copied from class: Example

Returns the number of representations in which this example is modeled

Specified by:

getNumberOfRepresentations in class Example

Returns:

the number of representations

getRepresentation

public Representation getRepresentation(String representationName)

Description copied from class: Example

Returns the representation corresponding to representationName

Specified by:

getRepresentation in class Example

Parameters:

representationName - it is a representation identifier

Returns:

the representation corresponding to representationName

equals

public boolean equals(Object example)

Overrides:

equals in class Example

equalsIgnoreLabels

public boolean equalsIgnoreLabels(SimpleExample example)

Asserts whether this example and the input one have identical representations, ignoring their labels

Parameters:

example -

Returns:

true if this example and the input one have identical representations, false otherwise

toString

public String toString()

Overrides:

toString in class Object

printExample

public String printExample(String... representations)

manipulate

public void manipulate(Manipulator manipulator)

Description copied from class: Example

Manipulate this example accordingly to the provided manipulator

Specified by:

manipulate in class Example

Parameters:

manipulator - the manipulator

isCompatible

public boolean isCompatible(Example example)

Description copied from class: Example

Evaluates whether an example is compatible with this one, i.e., they have the same structure in terms of Example type and representations

Specified by:

isCompatible in class Example

Parameters:

example - the example to be compared with this one

Returns:

whether this example is compatible with the input one