Package net.sf.okapi.common.resource

Class Ending

java.lang.Object

net.sf.okapi.common.resource.Ending

All Implemented Interfaces:

Cloneable, IResource, IWithAnnotations, IWithProperties, IWithSkeleton

Direct Known Subclasses:

EndSubfilter

public class Ending
extends Object
implements IResource

Resource associated with the filter events END_DOCUMENT, END_SUBDOCUMENT, and END_GROUP.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	id
protected ISkeleton	skeleton

Fields inherited from interface net.sf.okapi.common.IResource

COPY_ALL, COPY_CONTENT, COPY_PROPERTIES, COPY_SEGMENTATION, COPY_SEGMENTED_CONTENT, CREATE_EMPTY

Constructor Summary

Constructors

Constructor	Description
Ending()
Ending(String id)	Creates a new Ending object.

Method Summary

Modifier and Type	Method	Description
Annotations	getAnnotations()
String	getId()	Gets the identifier of the resource.
Map<String,Property>	getProperties()
ISkeleton	getSkeleton()	Gets the skeleton object for this resource.
void	setId(String id)	Sets the identifier of this resource.
void	setSkeleton(ISkeleton skeleton)	Sets the skeleton object for this resource.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.okapi.common.resource.IWithAnnotations

annotationIterator, clear, getAnnotation, getAnnotationsTypesAsSet, hasAnnotation, hasAnnotations, remove, setAnnotation

Methods inherited from interface net.sf.okapi.common.resource.IWithProperties

getProperty, getPropertyNames, hasProperty, propertyIterator, removeProperty, setProperty

Field Detail

id

protected String id

skeleton

protected ISkeleton skeleton

Constructor Detail

Ending

public Ending()

Ending

public Ending(String id)

Creates a new Ending object.

Parameters:

id - The ID of this resource (It should NOT be the same ID as the one set of the corresponding starting resource: each resource has a ID are unique).

Method Detail

getId

public String getId()

Description copied from interface: IResource

Gets the identifier of the resource. This identifier is unique per extracted document and by type of resource. This value is filter-specific. It and may be different from one extraction of the same document to the next. It can a sequential number or not, incremental or not, and it can be not a number. It has no correspondence in the source document ("IDs" coming from the source document are "names" and not available for all resources).

Specified by:

getId in interface IResource

Returns:

the identifier of this resource.

setId

public void setId(String id)

Description copied from interface: IResource

Sets the identifier of this resource.

Specified by:

setId in interface IResource

Parameters:

id - the new identifier value.

See Also:

IResource.getId()

getSkeleton

public ISkeleton getSkeleton()

Description copied from interface: IWithSkeleton

Gets the skeleton object for this resource.

Specified by:

getSkeleton in interface IWithSkeleton

Returns:

the skeleton object for this resource or null if there is none.

setSkeleton

public void setSkeleton(ISkeleton skeleton)

Description copied from interface: IWithSkeleton

Sets the skeleton object for this resource.

Specified by:

setSkeleton in interface IWithSkeleton

Parameters:

skeleton - the skeleton object to set.

toString

public String toString()

Overrides:

toString in class Object

getProperties

public Map<String,Property> getProperties()

Specified by:

getProperties in interface IWithProperties

Returns:

Map of properties for the implementer of interface

getAnnotations

public Annotations getAnnotations()

Specified by:

getAnnotations in interface IWithAnnotations

Returns:

Annotations for the implementer of interface