au.org.ala.checklist.lucene
Class DwcaNameIndexer

java.lang.Object
  au.org.ala.checklist.lucene.CBCreateLuceneIndex
      au.org.ala.checklist.lucene.DwcaNameIndexer

public class DwcaNameIndexer
extends CBCreateLuceneIndex

Create a name index from a DWCA. All the required names should exist in the supplied DWCA.

Author:

Natasha Quimby (natasha.quimby@csiro.au)

Nested Class Summary

Nested classes/interfaces inherited from class au.org.ala.checklist.lucene.CBCreateLuceneIndex

CBCreateLuceneIndex.IndexField

Field Summary

protected org.apache.commons.logging.Log

log

Fields inherited from class au.org.ala.checklist.lucene.CBCreateLuceneIndex

afdFile, alaConcepts, alaSynonyms, apniFile, cbExportFile, colFile, dataSource, extraALAConcepts, irmngDwcaDirectory, irmngFile, lexFile, taxonConeptName

Constructor Summary

DwcaNameIndexer()

Method Summary

void	create(boolean loadingIndex, boolean sciIndex, java.lang.String indexDirectory, java.lang.String tmpLoadIndex, java.lang.String namesDwc, java.lang.String irmngDwc, java.lang.String commonNameFile) Creates the name matching index based on a complete list of names supplied in a single DwCA
static void	main(java.lang.String[] args)

Methods inherited from class au.org.ala.checklist.lucene.CBCreateLuceneIndex

addAdditionalName, commit, commit, createALAIndexDocument, createALAIndexDocument, createALAIndexDocument, createALASynonymDocument, createIndex, createIndex, createIndexWriter, createIrmngIndex, deleteName, getCommonNameDocument, getCommonNameDocument, getIndexDirectory, indexIrmngDwcA, init, setIndexDirectory

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.commons.logging.Log log

Constructor Detail

DwcaNameIndexer

public DwcaNameIndexer()

Method Detail

create

public void create(boolean loadingIndex,
                   boolean sciIndex,
                   java.lang.String indexDirectory,
                   java.lang.String tmpLoadIndex,
                   java.lang.String namesDwc,
                   java.lang.String irmngDwc,
                   java.lang.String commonNameFile)
            throws java.lang.Exception

Creates the name matching index based on a complete list of names supplied in a single DwCA

Parameters:

loadingIndex - True when the loading index should be created. This is necessary to generate the index, but you may wish to skip this step if it has be generated earlier

sciIndex - True when the name matching index should be generated

indexDirectory - The directory in which to create the name matching index

tmpLoadIndex - The directory in which to create the temporary loading index

namesDwc - The absolute path to the

irmngDwc -

commonNameFile -

Throws:

java.lang.Exception

main

public static void main(java.lang.String[] args)