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-19, BSD License, Christian Gruen

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and 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 and 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, 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 Detail

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

Flag for the size limit on inlineable functions.

TAILCALLS

public static final NumberOption TAILCALLS

Flag for tail-call optimization.

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.

COMPPLAN

public static final BooleanOption COMPPLAN

Creates the query plan before or after compilation.

DOTPLAN

public static final BooleanOption DOTPLAN

Dots the query plan.

DOTCOMPACT

public static final BooleanOption DOTCOMPACT

Compact dot representation.

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 Detail

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 Detail

get

public static MainOptions get()

Creates a new options instance with whitespace chopping turned off.

Returns:

main options