net.sf.okapi.virtualdb

Interface IVItem

All Known Subinterfaces:

IVDocument, IVGroup, IVSet, IVSubDocument, IVTextUnit

All Known Implementing Classes:

H2Document, H2Group, H2Item, H2Set, H2SubDocument, H2TextUnit

public interface IVItem

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IVItem.ItemType

Method Summary

Methods

Modifier and Type	Method and Description
IVDocument	getDocument() Gets the document containing this item.
IVItem	getFirstChild() Gets the first child item of this item.
String	getId() Gets the extraction id for this item.
IVItem.ItemType	getItemType() Gets the type of item this item is (document, group, text unit, etc.)
long	getKey() Gets the storage key for this item.
String	getName() Gets the resource name of this item.
IVItem	getNextSibling() Gets the next item (on the same level) of this item.
IVItem	getParent() Gets the parent item of this item.
IVItem	getPreviousSibling() Gets the previous item (on the same level) of this item.
String	getType() Gets the resource type of this item.
void	save() Saves into the repository the modifiable data associated with this virtual item.

Method Detail

getId

String getId()

Gets the extraction id for this item. The extraction id is unique per document.

Returns:

the extraction id for this item.

getKey

long getKey()

Gets the storage key for this item. This key is unique for each virtual repository.

Returns:

the key for this item.

getName

String getName()

Gets the resource name of this item. This name depends on the type of item and can be null.

Returns:

the resource name of the item (can be null).

getType

String getType()

Gets the resource type of this item. This type depends on the type of item and can be null.

Returns:

the resource type of this item.

getParent

IVItem getParent()

Gets the parent item of this item.

Returns:

the parent item of this item, or null if it has no parent (e.g. for a IVDocument).

getNextSibling

IVItem getNextSibling()

Gets the next item (on the same level) of this item.

Returns:

the next item (on the same level) of this item, or null.

getPreviousSibling

IVItem getPreviousSibling()

Gets the previous item (on the same level) of this item.

Returns:

the previous item (on the same level) of this item, or null.

getFirstChild

IVItem getFirstChild()

Gets the first child item of this item.

Returns:

the first child item of this item, or null.

getDocument

IVDocument getDocument()

Gets the document containing this item.

Returns:

the document containing this item.

getItemType

IVItem.ItemType getItemType()

Gets the type of item this item is (document, group, text unit, etc.)

Returns:

one of the ItemType values.

save

void save()

Saves into the repository the modifiable data associated with this virtual item.