de::aitools::aq::invertedindex::core::Postlist< V extends Value > Class Reference

List of all members.

Classes

class  Head
class  PostlistIterator

Public Member Functions

Iterator< V > iterator ()
void deleteNative ()
Head getHead ()
boolean isEmpty ()
int size ()
void rewind ()

Protected Member Functions

 Postlist (Class< V > clazz, Pointer nativePtr, Head head)
void finalize () throws Throwable

Static Package Functions

 [static initializer]

Private Member Functions

native Pointer raw_postlist_next (Pointer raw_postlist)
native void raw_postlist_rewind (Pointer raw_postlist)
native void raw_postlist_delete (Pointer raw_postlist)

Private Attributes

PostlistIterator iterator
Pointer nativePostlist
Class< V > clazz
Head head

Detailed Description

A class of a iterable read-only postlist.

Author:
martin.trenkmann@uni-weimar.de
Version:
Id
Postlist.java,v 1.1 2011/02/16 04:41:23 trenkman Exp

Definition at line 24 of file Postlist.java.


Constructor & Destructor Documentation

de::aitools::aq::invertedindex::core::Postlist< V extends Value >::Postlist ( Class< V >  clazz,
Pointer  nativePtr,
Head  head 
) [inline, protected]

Initializes this postlist instance with its value type class object, a JNA Pointer to its native equivalent, and its head.

Definition at line 130 of file Postlist.java.


Member Function Documentation

de::aitools::aq::invertedindex::core::Postlist< V extends Value >::[static initializer] (  )  [inline, static, package]
void de::aitools::aq::invertedindex::core::Postlist< V extends Value >::deleteNative (  )  [inline]

Deletes the underlying native object. This method has to be called if the postlist needs not to be used any longer. Please look at the usage code UsingSearcher how and when to call this method.

Remember that an instance of Postlist is always coupled with a native object that is not observed by the Java garbage collector. Forgetting this results in an out-of-memory sooner or later.

Definition at line 152 of file Postlist.java.

void de::aitools::aq::invertedindex::core::Postlist< V extends Value >::finalize (  )  throws Throwable [inline, protected]

Definition at line 162 of file Postlist.java.

Head de::aitools::aq::invertedindex::core::Postlist< V extends Value >::getHead (  )  [inline]

Returns the Head of this postlist with some meta information.

Returns:
an instance of Head

Definition at line 172 of file Postlist.java.

boolean de::aitools::aq::invertedindex::core::Postlist< V extends Value >::isEmpty (  )  [inline]

Checks if the postlist is empty.

Returns:
true if the postlist is empty, false otherwise.

Definition at line 181 of file Postlist.java.

Iterator<V> de::aitools::aq::invertedindex::core::Postlist< V extends Value >::iterator (  )  [inline]

Definition at line 139 of file Postlist.java.

native void de::aitools::aq::invertedindex::core::Postlist< V extends Value >::raw_postlist_delete ( Pointer  raw_postlist  )  [private]
native Pointer de::aitools::aq::invertedindex::core::Postlist< V extends Value >::raw_postlist_next ( Pointer  raw_postlist  )  [private]
native void de::aitools::aq::invertedindex::core::Postlist< V extends Value >::raw_postlist_rewind ( Pointer  raw_postlist  )  [private]
void de::aitools::aq::invertedindex::core::Postlist< V extends Value >::rewind (  )  [inline]

Set the internal iterator to the beginning.

Definition at line 197 of file Postlist.java.

int de::aitools::aq::invertedindex::core::Postlist< V extends Value >::size (  )  [inline]

Get the number of entries.

Returns:
the number of postlist entries.

Definition at line 190 of file Postlist.java.


Member Data Documentation

Class<V> de::aitools::aq::invertedindex::core::Postlist< V extends Value >::clazz [private]

Definition at line 203 of file Postlist.java.

Head de::aitools::aq::invertedindex::core::Postlist< V extends Value >::head [private]

Definition at line 204 of file Postlist.java.

PostlistIterator de::aitools::aq::invertedindex::core::Postlist< V extends Value >::iterator [private]

Definition at line 201 of file Postlist.java.

Pointer de::aitools::aq::invertedindex::core::Postlist< V extends Value >::nativePostlist [private]

Definition at line 202 of file Postlist.java.


The documentation for this class was generated from the following file:
Generated on Wed May 30 15:07:45 2012 by  doxygen 1.6.3