net.sf.okapi.virtualdb

Interface IVDocument

All Superinterfaces:

IVItem, IVSet

All Known Implementing Classes:

H2Document

public interface IVDocument
extends IVSet

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.okapi.virtualdb.IVItem

IVItem.ItemType

Method Summary

Modifier and Type	Method and Description
Ending	getEndDocument() Gets the Ending resource associated with this document.
IVItem	getItem(long key) Gets the item for a given key.
IVItem	getItem(String extractionId) Gets the item for a given extraction id.
StartDocument	getStartDocument() Gets the StartDocument resource associated with this document.
IVTextUnit	getTextUnit(String extractionId) Gets the virtual text unit for a given extraction id.

Methods inherited from interface net.sf.okapi.virtualdb.IVSet

getFirstChild, items, textUnits

Methods inherited from interface net.sf.okapi.virtualdb.IVItem

getDocument, getId, getItemType, getKey, getName, getNextSibling, getParent, getPreviousSibling, getType, save

Method Detail

getStartDocument

StartDocument getStartDocument()

Gets the StartDocument resource associated with this document.

Returns:

the StartDocument resource associated with this document.

getEndDocument

Ending getEndDocument()

Gets the Ending resource associated with this document.

Returns:

the Ending resource associated with this document.

getItem

IVItem getItem(String extractionId)

Gets the item for a given extraction id.

Parameters:

extractionId - the extraction id for the item to retrieve.

Returns:

the item for the given extraction id.

getItem

IVItem getItem(long key)

Gets the item for a given key.

Parameters:

key - the key for the item to retrieve.

Returns:

the item retrieved for the given key.

getTextUnit

IVTextUnit getTextUnit(String extractionId)

Gets the virtual text unit for a given extraction id.

Parameters:

extractionId - the extraction id of the text unit to retrieve.

Returns:

the virtual text unit for a given extraction id.