Package org.basex.query.util.collation

Class BaseXCollationOptions

java.lang.Object

org.basex.util.options.Options

org.basex.query.util.collation.BaseXCollationOptions

All Implemented Interfaces:

Iterable<Option<?>>

public final class BaseXCollationOptions
extends Options

Project-specific collation options.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BaseXCollationOptions.Decomposition	Decomposition.
static enum	BaseXCollationOptions.Strength	Strength.

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 EnumOption<BaseXCollationOptions.Decomposition>	DECOMPOSITION	Option: decomposition.
static final StringOption	LANG	Option: language.
static final EnumOption<BaseXCollationOptions.Strength>	STRENGTH	Option: strength.

Constructor Summary

Constructors

Constructor	Description
BaseXCollationOptions(boolean fallback)	Constructor.

Method Summary

Modifier and Type	Method	Description
Collator	collator(HashMap<String,String> args)	Returns a collator for the specified arguments.
protected BaseXException	error(Option<?> option)	Creates an error for an invalid option.
Collation	get(HashMap<String,String> args)

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

LANG

public static final StringOption LANG

Option: language.

STRENGTH

public static final EnumOption<BaseXCollationOptions.Strength> STRENGTH

Option: strength.

DECOMPOSITION

public static final EnumOption<BaseXCollationOptions.Decomposition> DECOMPOSITION

Option: decomposition.

Constructor Details

BaseXCollationOptions

public BaseXCollationOptions(boolean fallback)

Constructor.

Parameters:

fallback - fallback option

Method Details

get

public Collation get(HashMap<String,String> args)
              throws BaseXException

Throws:

BaseXException

collator

public Collator collator(HashMap<String,String> args)
                  throws BaseXException

Returns a collator for the specified arguments.

Parameters:

args - argument to be parsed

Returns:

collator collator

Throws:

BaseXException - database exception

error

protected BaseXException error(Option<?> option)

Creates an error for an invalid option.

Parameters:

option - option

Returns:

error