Module org.apache.lucene.core

Package org.apache.lucene.index

Class FieldInfos.FieldNumbers

java.lang.Object

org.apache.lucene.index.FieldInfos.FieldNumbers

Enclosing class:

FieldInfos

static final class FieldInfos.FieldNumbers
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,FieldInfos.FieldDimensions>	dimensions
private final Map<String,DocValuesType>	docValuesType
private final Map<String,IndexOptions>	indexOptions
private int	lowestUnassignedFieldNumber
private final Map<String,Integer>	nameToNumber
private final IntObjectHashMap<String>	numberToName
private final Map<String,Boolean>	omitNorms
private final String	parentFieldName
private final String	softDeletesFieldName
private final Map<String,Boolean>	storeTermVectors
private final boolean	strictlyConsistent
private final Map<String,FieldInfos.FieldVectorProperties>	vectorProps

Constructor Summary

Constructors

Constructor	Description
FieldNumbers(String softDeletesFieldName, String parentFieldName, int indexCreatedVersionMajor)

Method Summary

Modifier and Type	Method	Description
(package private) int	addOrGet(FieldInfo fi)	Returns the global field number for the given field name.
(package private) void	clear()
(package private) FieldInfo	constructFieldInfo(String fieldName, DocValuesType dvType, int newFieldNumber)	Construct a new FieldInfo based on the options in global field numbers.
(package private) Set<String>	getFieldNames()
(package private) void	setDocValuesType(int number, String name, DocValuesType dvType)
(package private) void	verifyConsistent(Integer number, String name, DocValuesType dvType)
(package private) void	verifyFieldInfo(FieldInfo fi)
(package private) void	verifyOrCreateDvOnlyField(String fieldName, DocValuesType dvType, boolean fieldMustExist)	This function is called from IndexWriter to verify if doc values of the field can be updated.
private void	verifyParentFieldName(String fieldName, boolean isParentField)
private void	verifySameSchema(FieldInfo fi)
private void	verifySoftDeletedFieldName(String fieldName, boolean isSoftDeletesField)

Methods inherited from class java.lang.Object

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

Field Details

numberToName

private final IntObjectHashMap<String> numberToName

nameToNumber

private final Map<String,Integer> nameToNumber

indexOptions

private final Map<String,IndexOptions> indexOptions

docValuesType

private final Map<String,DocValuesType> docValuesType

dimensions

private final Map<String,FieldInfos.FieldDimensions> dimensions

vectorProps

private final Map<String,FieldInfos.FieldVectorProperties> vectorProps

omitNorms

private final Map<String,Boolean> omitNorms

storeTermVectors

private final Map<String,Boolean> storeTermVectors

lowestUnassignedFieldNumber

private int lowestUnassignedFieldNumber

softDeletesFieldName

private final String softDeletesFieldName

strictlyConsistent

private final boolean strictlyConsistent

parentFieldName

private final String parentFieldName

Constructor Details

FieldNumbers

FieldNumbers(String softDeletesFieldName,
 String parentFieldName,
 int indexCreatedVersionMajor)

Method Details

verifyFieldInfo

void verifyFieldInfo(FieldInfo fi)

addOrGet

int addOrGet(FieldInfo fi)

Returns the global field number for the given field name. If the name does not exist yet it tries to add it with the given preferred field number assigned if possible otherwise the first unassigned field number is used as the field number.

verifySoftDeletedFieldName

private void verifySoftDeletedFieldName(String fieldName,
 boolean isSoftDeletesField)

verifyParentFieldName

private void verifyParentFieldName(String fieldName,
 boolean isParentField)

verifySameSchema

private void verifySameSchema(FieldInfo fi)

verifyOrCreateDvOnlyField

void verifyOrCreateDvOnlyField(String fieldName,
 DocValuesType dvType,
 boolean fieldMustExist)

This function is called from IndexWriter to verify if doc values of the field can be updated. If the field with this name already exists, we verify that it is doc values only field. If the field doesn't exists and the parameter fieldMustExist is false, we create a new field in the global field numbers.

Parameters:

fieldName - - name of the field

dvType - - expected doc values type

fieldMustExist - – if the field must exist.

Throws:

IllegalArgumentException - if the field must exist, but it doesn't, or if the field exists, but it is not doc values only field with the provided doc values type.

constructFieldInfo

FieldInfo constructFieldInfo(String fieldName,
 DocValuesType dvType,
 int newFieldNumber)

Construct a new FieldInfo based on the options in global field numbers. This method is not synchronized as all the options it uses are not modifiable.

Parameters:

fieldName - name of the field

dvType - doc values type

newFieldNumber - a new field number

Returns:

null if fieldName doesn't exist in the map or is not of the same dvType returns a new FieldInfo based based on the options in global field numbers

setDocValuesType

void setDocValuesType(int number,
 String name,
 DocValuesType dvType)

verifyConsistent

void verifyConsistent(Integer number,
 String name,
 DocValuesType dvType)

getFieldNames

Set<String> getFieldNames()

clear

void clear()