net.sf.okapi.virtualdb.jdbc.h2

Class H2TextUnit

java.lang.Object

net.sf.okapi.virtualdb.jdbc.h2.H2TextUnit

All Implemented Interfaces:

IVItem, IVTextUnit

public class H2TextUnit
extends Object
implements IVTextUnit

Nested Class Summary

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

IVItem.ItemType

Constructor Summary

Constructors

Constructor and Description
H2TextUnit(long itemKey, H2Document doc, String id, String name, String type)

Method Summary

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.
ITextUnit	getTextUnit() Gets the TextUnit resource
String	getType() Gets the resource type of this item.
void	save() Saves into the repository the modifiable data associated with this virtual item.

Methods inherited from class java.lang.Object

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

Constructor Detail

H2TextUnit

public H2TextUnit(long itemKey,
                  H2Document doc,
                  String id,
                  String name,
                  String type)

Method Detail

getTextUnit

public ITextUnit getTextUnit()

Description copied from interface: IVTextUnit

Gets the TextUnit resource

Specified by:

getTextUnit in interface IVTextUnit

Returns:

the TextUnit resource

getDocument

public IVDocument getDocument()

Description copied from interface: IVItem

Gets the document containing this item.

Specified by:

getDocument in interface IVItem

Returns:

the document containing this item.

getParent

public IVItem getParent()

Description copied from interface: IVItem

Gets the parent item of this item.

Specified by:

getParent in interface IVItem

Returns:

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

getNextSibling

public IVItem getNextSibling()

Description copied from interface: IVItem

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

Specified by:

getNextSibling in interface IVItem

Returns:

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

getPreviousSibling

public IVItem getPreviousSibling()

Description copied from interface: IVItem

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

Specified by:

getPreviousSibling in interface IVItem

Returns:

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

getFirstChild

public IVItem getFirstChild()

Description copied from interface: IVItem

Gets the first child item of this item.

Specified by:

getFirstChild in interface IVItem

Returns:

the first child item of this item, or null.

save

public void save()

Description copied from interface: IVItem

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

Specified by:

save in interface IVItem

getItemType

public IVItem.ItemType getItemType()

Description copied from interface: IVItem

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

Specified by:

getItemType in interface IVItem

Returns:

one of the ItemType values.

getId

public String getId()

Description copied from interface: IVItem

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

Specified by:

getId in interface IVItem

Returns:

the extraction id for this item.

getName

public String getName()

Description copied from interface: IVItem

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

Specified by:

getName in interface IVItem

Returns:

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

getType

public String getType()

Description copied from interface: IVItem

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

Specified by:

getType in interface IVItem

Returns:

the resource type of this item.

getKey

public long getKey()

Description copied from interface: IVItem

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

Specified by:

getKey in interface IVItem

Returns:

the key for this item.