net.sf.okapi.common.annotation

Class IssueAnnotation

java.lang.Object

net.sf.okapi.common.resource.InlineAnnotation

net.sf.okapi.common.annotation.GenericAnnotation

net.sf.okapi.common.annotation.IssueAnnotation

All Implemented Interfaces:

Cloneable, IAnnotation, IPersistentAnnotation

public class IssueAnnotation
extends GenericAnnotation

Field Summary

Fields inherited from class net.sf.okapi.common.resource.InlineAnnotation

CLASSNAME_SEPARATOR, data

Constructor Summary

Constructors

Constructor and Description
IssueAnnotation()
IssueAnnotation(GenericAnnotation ann)
IssueAnnotation(IssueType issueType, String comment, double severity, String segId, int srcStart, int srcEnd, int trgStart, int trgEnd, List<Code> codes)

Method Summary

Modifier and Type	Method and Description
void	fromString(String storage) Initializes this annotation from a storage string originally obtained from InlineAnnotation.toString().
String	getCodes() Gets the string list of the codes for this issue.
String[]	getCodesAsArray()
List<Code>	getCodesAsList()
String	getComment()
boolean	getEnabled()
IssueType	getIssueType()
String	getITSType()
String	getProfileRef()
String	getSegId()
double	getSeverity()
int	getSourceEnd()
int	getSourceStart()
int	getTargetEnd()
int	getTargetStart()
void	setCodes(List<Code> codes)
void	setCodes(String codes)
void	setComment(String comment)
void	setEnabled(boolean enabled)
void	setIssueType(IssueType issueType) Sets the issue type and its corresponding ITS type mapping.
void	setITSType(String itsType)
void	setProfileRef(String profileRef)
void	setSegId(String segId)
void	setSeverity(double severity)
void	setSourcePosition(Integer start, Integer end)
void	setTargetPosition(Integer start, Integer end)
String	toString() Gets a storage string representation of the whole annotation that can be used for serialization.

Methods inherited from class net.sf.okapi.common.annotation.GenericAnnotation

addAnnotation, addAnnotation, addAnnotation, clone, createFromString, getBoolean, getDouble, getFieldCount, getInteger, getNames, getString, getType, remove, setBoolean, setDouble, setFields, setInteger, setString

Methods inherited from class net.sf.okapi.common.resource.InlineAnnotation

getData, setData

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueAnnotation

public IssueAnnotation()

IssueAnnotation

public IssueAnnotation(IssueType issueType,
                       String comment,
                       double severity,
                       String segId,
                       int srcStart,
                       int srcEnd,
                       int trgStart,
                       int trgEnd,
                       List<Code> codes)

IssueAnnotation

public IssueAnnotation(GenericAnnotation ann)

Method Detail

getIssueType

public IssueType getIssueType()

setIssueType

public void setIssueType(IssueType issueType)

Sets the issue type and its corresponding ITS type mapping. To override the default mapping, use setITSType(String).

Parameters:

issueType - the issue type to set.

getITSType

public String getITSType()

setITSType

public void setITSType(String itsType)

getSegId

public String getSegId()

setSegId

public void setSegId(String segId)

getSourceStart

public int getSourceStart()

getSourceEnd

public int getSourceEnd()

setSourcePosition

public void setSourcePosition(Integer start,
                              Integer end)

getTargetStart

public int getTargetStart()

getTargetEnd

public int getTargetEnd()

setTargetPosition

public void setTargetPosition(Integer start,
                              Integer end)

getEnabled

public boolean getEnabled()

setEnabled

public void setEnabled(boolean enabled)

getSeverity

public double getSeverity()

setSeverity

public void setSeverity(double severity)

getComment

public String getComment()

setComment

public void setComment(String comment)

getCodes

public String getCodes()

Gets the string list of the codes for this issue.

Returns:

the string list of the codes for this issue.

getCodesAsArray

public String[] getCodesAsArray()

getCodesAsList

public List<Code> getCodesAsList()

setCodes

public void setCodes(List<Code> codes)

setCodes

public void setCodes(String codes)

getProfileRef

public String getProfileRef()

setProfileRef

public void setProfileRef(String profileRef)

toString

public String toString()

Description copied from class: InlineAnnotation

Gets a storage string representation of the whole annotation that can be used for serialization.

Specified by:

toString in interface IAnnotation

Overrides:

toString in class GenericAnnotation

Returns:

The storage string representation of this annotation.

fromString

public void fromString(String storage)

Description copied from class: InlineAnnotation

Initializes this annotation from a storage string originally obtained from InlineAnnotation.toString().

Specified by:

fromString in interface IPersistentAnnotation

Overrides:

fromString in class GenericAnnotation

Parameters:

storage - The storage string to use for the initialization.