com.exalead.mot.components

Class VocabularyResource

java.lang.Object

com.exalead.gni.GNIObject

com.exalead.mot.core.Resource

com.exalead.mot.components.VocabularyResource

Direct Known Subclasses:

HierarchicalVocabularyResource

public class VocabularyResource
extends Resource

A resource for document classification.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	forceMmap Force mmap ? (if true mem will be shared but perfs will be impacted)
protected boolean	mlock Is the resource in RAM ?

Fields inherited from class com.exalead.mot.core.Resource

lang

Constructor Summary

Constructors

Constructor and Description
VocabularyResource(java.lang.String name, java.lang.String path, int lang) Loads a VocabularyResource.
VocabularyResource(java.lang.String name, java.lang.String path, int lang, boolean forceMmap)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	_getParametersDigest()
protected void	alloc(java.lang.String name, java.lang.String path, int lang, boolean mlock, boolean forceMmap) Allocate resource.
protected void	allocate() Function you should override to perform allocation of the underlying data.
void	dumpVocabulary() Debug: print the vocabulary to std::out
VocabularyIterator	enumerate() Allows to iterate on the resource's contents.
protected void	free() Function you should override to perform deallocation of the underlying data.

Methods inherited from class com.exalead.mot.core.Resource

equals, finalize, getExpandedPath, getExpandedPath, getExpandedPath, getExpandedPathIfExists, getExpandedPathIfExists, getIdentifier, getLang, getLangName, getName, hashCode, hasPath, register, register, release, release

Methods inherited from class com.exalead.gni.GNIObject

printInternalCppPointer

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

mlock

protected final boolean mlock

Is the resource in RAM ?

See Also:

Constant Field Values

forceMmap

protected boolean forceMmap

Force mmap ? (if true mem will be shared but perfs will be impacted)

Constructor Detail

VocabularyResource

public VocabularyResource(java.lang.String name,
                          java.lang.String path,
                          int lang)

Loads a VocabularyResource.

Parameters:

name - the resource's name.

path - URI of the resource.

lang - the resource's language.

VocabularyResource

public VocabularyResource(java.lang.String name,
                          java.lang.String path,
                          int lang,
                          boolean forceMmap)

Method Detail

_getParametersDigest

protected java.lang.String _getParametersDigest()

Overrides:

_getParametersDigest in class Resource

enumerate

public VocabularyIterator enumerate()

Allows to iterate on the resource's contents.

Returns:

an iterator for this resource.

dumpVocabulary

public void dumpVocabulary()

Debug: print the vocabulary to std::out

allocate

protected void allocate()
                 throws ResourceNotFoundException

Function you should override to perform allocation of the underlying data.

Specified by:

allocate in class Resource

Throws:

ResourceNotFoundException

alloc

protected void alloc(java.lang.String name,
                     java.lang.String path,
                     int lang,
                     boolean mlock,
                     boolean forceMmap)

Allocate resource.

free

protected void free()

Function you should override to perform deallocation of the underlying data.

Specified by:

free in class Resource