eus.ixa.ixa.pipe.ml.sequence

Class BioCodec

java.lang.Object

eus.ixa.ixa.pipe.ml.sequence.BioCodec

All Implemented Interfaces:

SequenceLabelerCodec<String>

public class BioCodec
extends Object
implements SequenceLabelerCodec<String>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTINUE
static String	OTHER
static String	START

Constructor Summary

Constructors

Constructor and Description
BioCodec()

Method Summary

Modifier and Type	Method and Description
boolean	areOutcomesCompatible(String[] outcomes) Checks if the outcomes of the model are compatible with the codec.
SequenceLabelerSequenceValidator	createSequenceValidator() Creates a sequence validator which can validate a sequence of outcomes.
Span[]	decode(List<String> c) Decodes a sequence T objects into Span objects.
String[]	encode(Span[] sequences, int length) Encodes Span objects into a sequence of T objects.
static String	extractSequenceType(String outcome)

Methods inherited from class java.lang.Object

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

Field Detail

START

public static final String START

See Also:

Constant Field Values

CONTINUE

public static final String CONTINUE

See Also:

Constant Field Values

OTHER

public static final String OTHER

See Also:

Constant Field Values

Constructor Detail

BioCodec

public BioCodec()

Method Detail

extractSequenceType

public static final String extractSequenceType(String outcome)

decode

public Span[] decode(List<String> c)

Description copied from interface: SequenceLabelerCodec

Decodes a sequence T objects into Span objects.

Specified by:

decode in interface SequenceLabelerCodec<String>

Parameters:

c - the sequence of objects

Returns:

the decoded Span array

encode

public String[] encode(Span[] sequences,
                       int length)

Description copied from interface: SequenceLabelerCodec

Encodes Span objects into a sequence of T objects.

Specified by:

encode in interface SequenceLabelerCodec<String>

Parameters:

sequences - the sequences

length - the length

Returns:

the encoded spans

createSequenceValidator

public SequenceLabelerSequenceValidator createSequenceValidator()

Description copied from interface: SequenceLabelerCodec

Creates a sequence validator which can validate a sequence of outcomes.

Specified by:

createSequenceValidator in interface SequenceLabelerCodec<String>

Returns:

the sequence validator

areOutcomesCompatible

public boolean areOutcomesCompatible(String[] outcomes)

Description copied from interface: SequenceLabelerCodec

Checks if the outcomes of the model are compatible with the codec.

Specified by:

areOutcomesCompatible in interface SequenceLabelerCodec<String>

Parameters:

outcomes - all possible model outcomes

Returns:

whether they are compatible or not