net.sf.okapi.virtualdb.jdbc.h2

Class H2Document

java.lang.Object

net.sf.okapi.virtualdb.jdbc.h2.H2Document

All Implemented Interfaces:

IVDocument, IVItem, IVSet

public class H2Document
extends Object
implements IVDocument

Nested Class Summary

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

IVItem.ItemType

Field Summary

Fields

Modifier and Type	Field and Description
protected long	docKey
protected long	firstChild
protected IVItem.ItemType	itemType
protected long	key
protected int	level
protected long	next
protected long	parent
protected long	previous

Constructor Summary

Constructors

Constructor and Description
H2Document(H2Access access, long key, String id, String name, String type)

Method Summary

Modifier and Type	Method and Description
void	fillPointers(long parent, long firstChild, long previous, long next)
IVDocument	getDocument() Gets the document containing this item.
Ending	getEndDocument() Gets the Ending resource associated with this document.
IVItem	getFirstChild() Gets the first child item of this set.
String	getId() Gets the extraction id for this item.
IVItem	getItem(long key) Gets the item for a given key.
IVItem	getItem(String extractionId) Gets the item for a given extraction id.
IVItem.ItemType	getItemType() Gets the type of item this item is (document, group, text unit, etc.)
long	getKey()
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.
StartDocument	getStartDocument() Gets the StartDocument resource associated with this document.
IVTextUnit	getTextUnit(String extractionId) Gets the virtual text unit for a given extraction id.
String	getType() Gets the resource type of this item.
Iterable<IVItem>	items() Creates an iterable object for all the items in this set.
void	save() Saves into the repository the modifiable data associated with this virtual item.
Iterable<IVTextUnit>	textUnits() Creates an iterable object for all the virtual text units in this set.

Methods inherited from class java.lang.Object

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

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

getKey

Field Detail

key

protected long key

docKey

protected long docKey

itemType

protected IVItem.ItemType itemType

level

protected int level

parent

protected long parent

firstChild

protected long firstChild

next

protected long next

previous

protected long previous

Constructor Detail

H2Document

public H2Document(H2Access access,
                  long key,
                  String id,
                  String name,
                  String type)

Method Detail

fillPointers

public void fillPointers(long parent,
                         long firstChild,
                         long previous,
                         long next)

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.

getEndDocument

public Ending getEndDocument()

Description copied from interface: IVDocument

Gets the Ending resource associated with this document.

Specified by:

getEndDocument in interface IVDocument

Returns:

the Ending resource associated with this document.

getItem

public IVItem getItem(String extractionId)

Description copied from interface: IVDocument

Gets the item for a given extraction id.

Specified by:

getItem in interface IVDocument

Parameters:

extractionId - the extraction id for the item to retrieve.

Returns:

the item for the given extraction id.

getItem

public IVItem getItem(long key)

Description copied from interface: IVDocument

Gets the item for a given key.

Specified by:

getItem in interface IVDocument

Parameters:

key - the key for the item to retrieve.

Returns:

the item retrieved for the given key.

getStartDocument

public StartDocument getStartDocument()

Description copied from interface: IVDocument

Gets the StartDocument resource associated with this document.

Specified by:

getStartDocument in interface IVDocument

Returns:

the StartDocument resource associated with this document.

getTextUnit

public IVTextUnit getTextUnit(String extractionId)

Description copied from interface: IVDocument

Gets the virtual text unit for a given extraction id.

Specified by:

getTextUnit in interface IVDocument

Parameters:

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

Returns:

the virtual text unit for a given extraction id.

getFirstChild

public IVItem getFirstChild()

Description copied from interface: IVSet

Gets the first child item of this set.

Specified by:

getFirstChild in interface IVItem

Specified by:

getFirstChild in interface IVSet

Returns:

the first child item of this set, or null if there is no child.

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.

items

public Iterable<IVItem> items()

Description copied from interface: IVSet

Creates an iterable object for all the items in this set.

Specified by:

items in interface IVSet

Returns:

a new iterable object for all the items in this set.

textUnits

public Iterable<IVTextUnit> textUnits()

Description copied from interface: IVSet

Creates an iterable object for all the virtual text units in this set.

Specified by:

textUnits in interface IVSet

Returns:

a new iterable object for all the virtual text units in this set.

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.

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).

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.

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).

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.

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.

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

getKey

public long getKey()