Package org.basex.core

Class MainOptions

java.lang.Object

org.basex.util.options.Options

org.basex.core.MainOptions

All Implemented Interfaces:

Iterable<Option<?>>

public final class MainOptions
extends Options

This class contains database options which are used all around the project.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MainOptions.MainParser	Parser.

Nested classes/interfaces inherited from class org.basex.util.options.Options

Options.YesNo, Options.YesNoOmit

Field Summary

Fields

Modifier and Type	Field	Description
static final BooleanOption	ADDARCHIVES	Flag for adding archives to a database.
static final BooleanOption	ADDCACHE	Cache new documents before adding them to a database.
static final BooleanOption	ADDRAW	Flag for adding remaining files as raw files.
static final BooleanOption	ARCHIVENAME	Flag for prefixing database paths with name of archive.
static final StringOption	ATTRINCLUDE	Attribute index: names to include.
static final BooleanOption	ATTRINDEX	Flag for creating an attribute value index.
static final BooleanOption	AUTOFLUSH	Flushes the database after each update.
static final BooleanOption	AUTOOPTIMIZE	Flag for automatic index updates.
static final StringOption	BINDINGS	External variables, separated by commas.
static final BooleanOption	CASESENS	Flag for full-text case sensitivity.
static final StringOption	CATFILE	Path to XML Catalog file.
static final BooleanOption	CHECKSTRINGS	Validate string inputs.
static final BooleanOption	CHOP	Flag for whitespace chopping.
static final BooleanOption	COMPPLAN	Creates the query plan before or after compilation.
static final BooleanOption	COPYNODE	Deep node copies.
static final StringOption	CREATEFILTER	Path for filtering XML Documents.
static final BooleanOption	CREATEONLY	Flag for closing a database after creating it.
static final OptionsOption<CsvParserOptions>	CSVPARSER	Define CSV parser options.
static final BooleanOption	DEFAULTDB	Favor global database when opening resources.
static final BooleanOption	DIACRITICS	Flag for full-text diacritics sensitivity.
static final BooleanOption	DTD	Flag for parsing DTDs.
static final BooleanOption	ENFORCEINDEX	Flag for enforcing index rewritings.
static final OptionsOption<SerializerOptions>	EXPORTER	Exporter serialization parameters.
static final BooleanOption	FORCECREATE	Forces database creation for unknown documents.
static final StringOption	FTINCLUDE	Full-text index: names to include.
static final BooleanOption	FTINDEX	Flag for creating a full-text index.
static final BooleanOption	FULLPLAN	Creates comprehensive query plan information.
static final OptionsOption<HtmlOptions>	HTMLPARSER	Define TagSoup HTML options.
static final NumberOption	INLINELIMIT	Limit for inlining functions.
static final BooleanOption	INTPARSE	Use internal XML parser.
static final OptionsOption<JsonParserOptions>	JSONPARSER	Define JSON parser options.
static final StringOption	LANGUAGE	Language for full-text search index.
static final NumberOption	LSERROR	Levenshtein default error.
static final BooleanOption	MAINMEM	Flag for creating a main memory database.
static final NumberOption	MAXCATS	Maximum number of name categories.
static final NumberOption	MAXLEN	Maximum length of index entries.
static final NumberOption	MAXSTAT	Maximum number of index occurrences to print.
static final BooleanOption	MIXUPDATES	Flag for mixing updates and items.
static final EnumOption<MainOptions.MainParser>	PARSER	Define import parser.
static final BooleanOption	QUERYINFO	Detailed query information.
static final BooleanOption	RUNQUERY	Runs the query results, or only parses it.
static final NumberOption	RUNS	Number of query executions.
static final BooleanOption	SERIALIZE	Flag for serializing query results.
static final OptionsOption<SerializerOptions>	SERIALIZER	Serialization parameters.
static final BooleanOption	SKIPCORRUPT	Flag for skipping corrupt files.
static final NumberOption	SPLITSIZE	Index split size.
static final BooleanOption	STEMMING	Flag for full-text stemming.
static final StringOption	STOPWORDS	Path to full-text stopword list.
static final BooleanOption	STRIPNS	Strips namespaces.
static final NumberOption	TAILCALLS	Flag for tail-call optimization.
static final StringOption	TEXTINCLUDE	Text index: names to include.
static final BooleanOption	TEXTINDEX	Flag for creating a text index.
static final OptionsOption<TextOptions>	TEXTPARSER	Define text parser options.
static final StringOption	TOKENINCLUDE	Token index: names to include.
static final BooleanOption	TOKENINDEX	Flag for creating a token index.
static final NumberOption	UNROLLLIMIT	Limit for unrolling loops.
static final BooleanOption	UPDINDEX	Flag for activating incremental index structures.
static final BooleanOption	WITHDB	Look up documents in databases.
static final BooleanOption	WRITEBACK	Writes original files back after updates.
static final BooleanOption	XINCLUDE	Flag for using XInclude.
static final BooleanOption	XMLPLAN	Prints an XML plan.

Constructor Summary

Constructors

Constructor	Description
MainOptions()	Default constructor.
MainOptions(boolean system)	Default constructor.
MainOptions(MainOptions options)	Constructor, adopting the specified options.
MainOptions(MainOptions options, boolean xml)	Constructor, adopting XML parsing options from the specified options.

Method Summary

Modifier and Type	Method	Description
static MainOptions	get()	Creates a new options instance with whitespace chopping turned off.

Methods inherited from class org.basex.util.options.Options

allowed, assign, assign, assign, assign, assign, contains, error, free, get, get, get, get, get, get, get, get, get, invert, iterator, names, option, put, set, set, set, set, set, set, set, set, setSystem, toMap, toMap, toString, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

MAINMEM

public static final BooleanOption MAINMEM

Flag for creating a main memory database.

CREATEONLY

public static final BooleanOption CREATEONLY

Flag for closing a database after creating it.

CREATEFILTER

public static final StringOption CREATEFILTER

Path for filtering XML Documents.

ADDARCHIVES

public static final BooleanOption ADDARCHIVES

Flag for adding archives to a database.

ARCHIVENAME

public static final BooleanOption ARCHIVENAME

Flag for prefixing database paths with name of archive.

SKIPCORRUPT

public static final BooleanOption SKIPCORRUPT

Flag for skipping corrupt files.

ADDRAW

public static final BooleanOption ADDRAW

Flag for adding remaining files as raw files.

CSVPARSER

public static final OptionsOption<CsvParserOptions> CSVPARSER

Define CSV parser options.

TEXTPARSER

public static final OptionsOption<TextOptions> TEXTPARSER

Define text parser options.

JSONPARSER

public static final OptionsOption<JsonParserOptions> JSONPARSER

Define JSON parser options.

HTMLPARSER

public static final OptionsOption<HtmlOptions> HTMLPARSER

Define TagSoup HTML options.

PARSER

public static final EnumOption<MainOptions.MainParser> PARSER

Define import parser.

CHOP

public static final BooleanOption CHOP

Flag for whitespace chopping.

INTPARSE

public static final BooleanOption INTPARSE

Use internal XML parser.

STRIPNS

public static final BooleanOption STRIPNS

Strips namespaces.

DTD

public static final BooleanOption DTD

Flag for parsing DTDs.

XINCLUDE

public static final BooleanOption XINCLUDE

Flag for using XInclude.

CATFILE

public static final StringOption CATFILE

Path to XML Catalog file.

ADDCACHE

public static final BooleanOption ADDCACHE

Cache new documents before adding them to a database.

TEXTINDEX

public static final BooleanOption TEXTINDEX

Flag for creating a text index.

ATTRINDEX

public static final BooleanOption ATTRINDEX

Flag for creating an attribute value index.

TOKENINDEX

public static final BooleanOption TOKENINDEX

Flag for creating a token index.

FTINDEX

public static final BooleanOption FTINDEX

Flag for creating a full-text index.

TEXTINCLUDE

public static final StringOption TEXTINCLUDE

Text index: names to include.

ATTRINCLUDE

public static final StringOption ATTRINCLUDE

Attribute index: names to include.

TOKENINCLUDE

public static final StringOption TOKENINCLUDE

Token index: names to include.

FTINCLUDE

public static final StringOption FTINCLUDE

Full-text index: names to include.

MAXLEN

public static final NumberOption MAXLEN

Maximum length of index entries.

MAXCATS

public static final NumberOption MAXCATS

Maximum number of name categories.

UPDINDEX

public static final BooleanOption UPDINDEX

Flag for activating incremental index structures.

AUTOOPTIMIZE

public static final BooleanOption AUTOOPTIMIZE

Flag for automatic index updates.

SPLITSIZE

public static final NumberOption SPLITSIZE

Index split size.

STEMMING

public static final BooleanOption STEMMING

Flag for full-text stemming.

CASESENS

public static final BooleanOption CASESENS

Flag for full-text case sensitivity.

DIACRITICS

public static final BooleanOption DIACRITICS

Flag for full-text diacritics sensitivity.

LANGUAGE

public static final StringOption LANGUAGE

Language for full-text search index.

STOPWORDS

public static final StringOption STOPWORDS

Path to full-text stopword list.

QUERYINFO

public static final BooleanOption QUERYINFO

Detailed query information.

MIXUPDATES

public static final BooleanOption MIXUPDATES

Flag for mixing updates and items.

BINDINGS

public static final StringOption BINDINGS

External variables, separated by commas.

INLINELIMIT

public static final NumberOption INLINELIMIT

Limit for inlining functions.

UNROLLLIMIT

public static final NumberOption UNROLLLIMIT

Limit for unrolling loops.

TAILCALLS

public static final NumberOption TAILCALLS

Flag for tail-call optimization.

WITHDB

public static final BooleanOption WITHDB

Look up documents in databases.

DEFAULTDB

public static final BooleanOption DEFAULTDB

Favor global database when opening resources.

FORCECREATE

public static final BooleanOption FORCECREATE

Forces database creation for unknown documents.

CHECKSTRINGS

public static final BooleanOption CHECKSTRINGS

Validate string inputs.

LSERROR

public static final NumberOption LSERROR

Levenshtein default error.

RUNQUERY

public static final BooleanOption RUNQUERY

Runs the query results, or only parses it.

RUNS

public static final NumberOption RUNS

Number of query executions.

ENFORCEINDEX

public static final BooleanOption ENFORCEINDEX

Flag for enforcing index rewritings.

COPYNODE

public static final BooleanOption COPYNODE

Deep node copies.

SERIALIZE

public static final BooleanOption SERIALIZE

Flag for serializing query results.

SERIALIZER

public static final OptionsOption<SerializerOptions> SERIALIZER

Serialization parameters.

EXPORTER

public static final OptionsOption<SerializerOptions> EXPORTER

Exporter serialization parameters.

XMLPLAN

public static final BooleanOption XMLPLAN

Prints an XML plan.

FULLPLAN

public static final BooleanOption FULLPLAN

Creates comprehensive query plan information.

COMPPLAN

public static final BooleanOption COMPPLAN

Creates the query plan before or after compilation.

AUTOFLUSH

public static final BooleanOption AUTOFLUSH

Flushes the database after each update.

WRITEBACK

public static final BooleanOption WRITEBACK

Writes original files back after updates.

MAXSTAT

public static final NumberOption MAXSTAT

Maximum number of index occurrences to print.

Constructor Details

MainOptions

public MainOptions()

Default constructor.

MainOptions

public MainOptions(boolean system)

Default constructor.

Parameters:

system - parse system properties

MainOptions

public MainOptions(MainOptions options)

Constructor, adopting the specified options.

Parameters:

options - parent options

MainOptions

public MainOptions(MainOptions options,
 boolean xml)

Constructor, adopting XML parsing options from the specified options.

Parameters:

options - parent options

xml - adopt xml options

Method Details

get

public static MainOptions get()

Creates a new options instance with whitespace chopping turned off.

Returns:

main options