Package org.basex.data

Enum Class MetaProp

java.lang.Object

java.lang.Enum<MetaProp>

org.basex.data.MetaProp

All Implemented Interfaces:

Serializable, Comparable<MetaProp>, java.lang.constant.Constable

public enum MetaProp
extends Enum<MetaProp>

This class provides meta properties.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTRINCLUDE	Property.
ATTRINDEX	Property.
AUTOOPTIMIZE	Property.
BINARIES	Property.
CASESENS	Property.
DIACRITICS	Property.
DOCUMENTS	Property.
FTINCLUDE	Property.
FTINDEX	Property.
INPUTDATE	Property.
INPUTPATH	Property.
INPUTSIZE	Property.
LANGUAGE	Property.
MAXCATS	Property.
MAXLEN	Property.
NAME	Property.
NODES	Property.
SIZE	Property.
SPLITSIZE	Property.
STEMMING	Property.
STOPWORDS	Property.
TEXTINCLUDE	Property.
TEXTINDEX	Property.
TIMESTAMP	Property.
TOKENINCLUDE	Property.
TOKENINDEX	Property.
UPDINDEX	Property.
UPTODATE	Property.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	index	Index property.
static final MetaProp[]	VALUES	Cached enums (faster).

Method Summary

Modifier and Type	Method	Description
static MetaProp	get(String name)	Returns a property matching the specified string.
abstract Object	value(MetaData meta)	Returns the value of a property.
static MetaProp	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetaProp[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NAME

public static final MetaProp NAME

Property.

SIZE

public static final MetaProp SIZE

Property.

NODES

public static final MetaProp NODES

Property.

DOCUMENTS

public static final MetaProp DOCUMENTS

Property.

BINARIES

public static final MetaProp BINARIES

Property.

TIMESTAMP

public static final MetaProp TIMESTAMP

Property.

UPTODATE

public static final MetaProp UPTODATE

Property.

INPUTPATH

public static final MetaProp INPUTPATH

Property.

INPUTSIZE

public static final MetaProp INPUTSIZE

Property.

INPUTDATE

public static final MetaProp INPUTDATE

Property.

TEXTINDEX

public static final MetaProp TEXTINDEX

Property.

ATTRINDEX

public static final MetaProp ATTRINDEX

Property.

TOKENINDEX

public static final MetaProp TOKENINDEX

Property.

FTINDEX

public static final MetaProp FTINDEX

Property.

TEXTINCLUDE

public static final MetaProp TEXTINCLUDE

Property.

ATTRINCLUDE

public static final MetaProp ATTRINCLUDE

Property.

TOKENINCLUDE

public static final MetaProp TOKENINCLUDE

Property.

FTINCLUDE

public static final MetaProp FTINCLUDE

Property.

LANGUAGE

public static final MetaProp LANGUAGE

Property.

STEMMING

public static final MetaProp STEMMING

Property.

CASESENS

public static final MetaProp CASESENS

Property.

DIACRITICS

public static final MetaProp DIACRITICS

Property.

STOPWORDS

public static final MetaProp STOPWORDS

Property.

UPDINDEX

public static final MetaProp UPDINDEX

Property.

AUTOOPTIMIZE

public static final MetaProp AUTOOPTIMIZE

Property.

MAXCATS

public static final MetaProp MAXCATS

Property.

MAXLEN

public static final MetaProp MAXLEN

Property.

SPLITSIZE

public static final MetaProp SPLITSIZE

Property.

Field Details

index

public final boolean index

Index property.

VALUES

public static final MetaProp[] VALUES

Cached enums (faster).

Method Details

values

public static MetaProp[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MetaProp valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

value

public abstract Object value(MetaData meta)

Returns the value of a property.

Parameters:

meta - meta data

Returns:

value

get

public static MetaProp get(String name)

Returns a property matching the specified string.

Parameters:

name - name of enumeration

Returns:

permission, or null if no match is found