nl.inl.blacklab.search.indexmetadata

Class AnnotatedFieldImpl

java.lang.Object

nl.inl.blacklab.search.indexmetadata.FieldImpl

nl.inl.blacklab.search.indexmetadata.AnnotatedFieldImpl

All Implemented Interfaces:

AnnotatedField, Field, Freezable<AnnotatedFieldImpl>

public class AnnotatedFieldImpl
extends FieldImpl
implements AnnotatedField, Freezable<AnnotatedFieldImpl>

An annotated field

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AnnotatedFieldImpl.AnnotationsImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.logging.log4j.Logger	logger

Fields inherited from class nl.inl.blacklab.search.indexmetadata.FieldImpl

contentStore, description, displayName, fieldName

Method Summary

Modifier and Type	Method and Description
Annotations	annotations() Get the annotations for this field.
AnnotatedFieldImpl	freeze()
Set<String>	getNoForwardIndexAnnotations()
nl.inl.blacklab.search.indexmetadata.AnnotationImpl	getOrCreateAnnotation(String name)
boolean	hasLengthTokens()
boolean	hasPunctuationForwardIndex() Checks if this field has a "punctuation" forward index, storing all the intra-word characters (whitespace and punctuation) so we can build concordances directly from the forward indices.
boolean	hasTokenLengthDocValues() Was the field that stores the length of this field in tokens indexed with DocValues?
boolean	hasXmlTags()
boolean	isFrozen()
String	offsetsField() Get the Lucene field that contains character offsets (if any)
String	tokenLengthField() Returns the Lucene field that contains the length (in tokens) of this field, or null if there is no such field.
String	toString()

Methods inherited from class nl.inl.blacklab.search.indexmetadata.FieldImpl

description, displayName, equals, hasContentStore, hashCode, name, setDescription, setDisplayName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface nl.inl.blacklab.search.indexmetadata.AnnotatedField

annotation, contentsFieldName, isDummyFieldToStoreLinkedDocuments, mainAnnotation

Methods inherited from interface nl.inl.blacklab.search.indexmetadata.Field

contentIdField, description, displayName, hasContentStore, name

Methods inherited from interface nl.inl.blacklab.search.indexmetadata.Freezable

ensureNotFrozen

Field Detail

logger

protected static final org.apache.logging.log4j.Logger logger

Method Detail

toString

public String toString()

Overrides:

toString in class FieldImpl

annotations

public Annotations annotations()

Description copied from interface: AnnotatedField

Get the annotations for this field. Properties are returned sorted according to the displayOrder defined in the index metadata, if any.

Specified by:

annotations in interface AnnotatedField

Returns:

the annotations

hasLengthTokens

public boolean hasLengthTokens()

Specified by:

hasLengthTokens in interface AnnotatedField

tokenLengthField

public String tokenLengthField()

Returns the Lucene field that contains the length (in tokens) of this field, or null if there is no such field.

Specified by:

tokenLengthField in interface AnnotatedField

Returns:

the field name or null if lengths weren't stored

hasXmlTags

public boolean hasXmlTags()

Specified by:

hasXmlTags in interface AnnotatedField

hasPunctuationForwardIndex

public boolean hasPunctuationForwardIndex()

Checks if this field has a "punctuation" forward index, storing all the intra-word characters (whitespace and punctuation) so we can build concordances directly from the forward indices.

Specified by:

hasPunctuationForwardIndex in interface AnnotatedField

Returns:

true iff there's a punctuation forward index.

getNoForwardIndexAnnotations

public Set<String> getNoForwardIndexAnnotations()

getOrCreateAnnotation

public nl.inl.blacklab.search.indexmetadata.AnnotationImpl getOrCreateAnnotation(String name)

freeze

public AnnotatedFieldImpl freeze()

Specified by:

freeze in interface Freezable<AnnotatedFieldImpl>

isFrozen

public boolean isFrozen()

Specified by:

isFrozen in interface Freezable<AnnotatedFieldImpl>

offsetsField

public String offsetsField()

Description copied from interface: Field

Get the Lucene field that contains character offsets (if any)

Specified by:

offsetsField in interface Field

Returns:

lucene field containing offsets, or null if there is none

hasTokenLengthDocValues

public boolean hasTokenLengthDocValues()

Description copied from interface: AnnotatedField

Was the field that stores the length of this field in tokens indexed with DocValues?

Specified by:

hasTokenLengthDocValues in interface AnnotatedField

Returns:

true if it was, false if not