BuildOptions

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> greenstone >> gatherer >> [ gui overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.greenstone.gatherer.gui.BuildOptions

SOURCE |

Download org.greenstone.gatherer.gui.BuildOptions

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.greenstone.gatherer.gui
Class BuildOptions

java.lang.Object
  org.greenstone.gatherer.gui.BuildOptions

All Implemented Interfaces:: java.io.Serializable

public class BuildOptions
extends java.lang.Object
implements java.io.Serializable

This data-only class contains all of the import and build options which persist between sessions, which currently is all of them.

Version:: 2.3

Field Summary

boolean allclassifications
          Do we include empty classifications?

static byte ALLCLASSIFICATIONS
          Element of option type enumeration.

boolean archivedir
          Have we set an archive directory?

static byte ARCHIVEDIR
          Element of option type enumeration.

java.lang.String archivedir_value
          The archive directory.

static byte BUILD_ARGS
          Element of argument type enumeration.

boolean builddir
          Have we set a build directory?

static byte BUILDDIR
          Element of option type enumeration.

java.lang.String builddir_value
          The building directory.

boolean collectdir
          Have we set a collect directory?

static byte COLLECTDIR
          Element of option type enumeration.

java.lang.String collectdir_value
          The collect directory.

boolean create_images
          Do we want the build process to create images as it goes along?

static byte CREATEIMAGES
          Element of option type enumeration.

boolean debug
          Do we want debug information?

static byte DEBUG
          Element of option type enumeration.

boolean groupsize
          Have we set a groupsize value?

static byte GROUPSIZE
          Element of option type enumeration.

int groupsize_value
          How many documents to a hash group in the archive?

boolean gzip
          Do we want the contents of the archive directory zipped?

static byte GZIP
          Element of option type enumeration.

static byte IMPORT_ARGS
          Element of argument type enumeration.

boolean importdir
          Have we set an import directory?

static byte IMPORTDIR
          Element of option type enumeration.

java.lang.String importdir_value
          The import directory.

boolean index
          Have we selected to build the collection on certain indexes?

static byte INDEX
          Element of option type enumeration.

java.lang.String[] index_value
          The names of classifiers to be indexes for.

boolean keepold
          Do we explicitly want to keep the archives dir?

static byte KEEPOLD
          Element of option type enumeration.

boolean maxdocs
          Have we set a maxdocs value?

static byte MAXDOCS
          Element of option type enumeration.

int maxdocs_value
          What is the maximum number of documents to process?

boolean mode
          Have we selected a certain mode to build in?

static byte MODE
          Element of option type enumeration.

java.lang.String mode_value
          The build mode.

boolean notext
          Do we build the indexes, but store no compressed text?

static byte NOTEXT
          Element of option type enumeration.

boolean oidtype
          Have we decided on a OID type?

static byte OIDTYPE
          Element of option type enumeration.

java.lang.String oidtype_value
          The OID generation method.

boolean out
          Have we set an out file?

static byte OUT
          Element of option type enumeration.

java.lang.String out_value
          The name of the file to write std_err to.

boolean removeold
          Do we explicitly want to remove the archives dir?

static byte REMOVEOLD
          Element of option type enumeration.

boolean sortmeta
          Have we choosen a metadata element to sort on?

static byte SORTMETA
          Element of option type enumeration.

java.lang.String sortmeta_value
          The name of the metadata element to sort the collection by.

boolean verbosity
          Have we set a verbosity value?

static byte VERBOSITY
          Element of option type enumeration.

byte verbosity_value
          What is the desired level of verbosity?

Constructor Summary

BuildOptions()
          This constructor initializes values by using the current configuration and collect if there is one.

Method Summary

BuildOptions copy()
          This method returns a copy of this current BuildOptions object.

java.lang.String[] getArguments(byte type)
          When called this method returns the required arguments selected by the user.

Methods inherited from class java.lang.Object

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

Field Detail

allclassifications

public boolean allclassifications

Do we include empty classifications?

archivedir

public boolean archivedir

Have we set an archive directory?

builddir

public boolean builddir

Have we set a build directory?

debug

public boolean debug

Do we want debug information?

collectdir

public boolean collectdir

Have we set a collect directory?

create_images

public boolean create_images

Do we want the build process to create images as it goes along?

groupsize

public boolean groupsize

Have we set a groupsize value?

gzip

public boolean gzip

Do we want the contents of the archive directory zipped?

importdir

public boolean importdir

Have we set an import directory?

index

public boolean index

Have we selected to build the collection on certain indexes?

keepold

public boolean keepold

Do we explicitly want to keep the archives dir?

maxdocs

public boolean maxdocs

Have we set a maxdocs value?

mode

public boolean mode

Have we selected a certain mode to build in?

notext

public boolean notext

Do we build the indexes, but store no compressed text?

oidtype

public boolean oidtype

Have we decided on a OID type?

out

public boolean out

Have we set an out file?

removeold

public boolean removeold

Do we explicitly want to remove the archives dir?

sortmeta

public boolean sortmeta

Have we choosen a metadata element to sort on?

verbosity

public boolean verbosity

Have we set a verbosity value?

groupsize_value

public int groupsize_value

How many documents to a hash group in the archive?

maxdocs_value

public int maxdocs_value

What is the maximum number of documents to process?

verbosity_value

public byte verbosity_value

What is the desired level of verbosity?

archivedir_value

public java.lang.String archivedir_value

The archive directory.

builddir_value

public java.lang.String builddir_value

The building directory.

collectdir_value

public java.lang.String collectdir_value

The collect directory.

importdir_value

public java.lang.String importdir_value

The import directory.

mode_value

public java.lang.String mode_value

The build mode.

oidtype_value

public java.lang.String oidtype_value

The OID generation method.

out_value

public java.lang.String out_value

The name of the file to write std_err to.

sortmeta_value

public java.lang.String sortmeta_value

The name of the metadata element to sort the collection by.

index_value

public java.lang.String[] index_value

The names of classifiers to be indexes for.

BUILD_ARGS

public static final byte BUILD_ARGS

Element of argument type enumeration.

See Also:: Constant Field Values

IMPORT_ARGS

public static final byte IMPORT_ARGS

Element of argument type enumeration.

See Also:: Constant Field Values