nl.inl.blacklab.mocks

Class MockAnnotatedField

java.lang.Object

nl.inl.blacklab.mocks.MockAnnotatedField

All Implemented Interfaces:

AnnotatedField, Field

public class MockAnnotatedField
extends Object
implements AnnotatedField

Constructor Summary

Constructors

Constructor and Description
MockAnnotatedField(String name, List<Annotation> annotations)

Method Summary

Modifier and Type	Method and Description
Annotations	annotations() Get the annotations for this field.
String	description() Get this field's display name
String	displayName() Get this field's display name
boolean	hasContentStore() Is this field's content stored in a content store?
boolean	hasLengthTokens()
boolean	hasPunctuationForwardIndex()
boolean	hasTokenLengthDocValues() Was the field that stores the length of this field in tokens indexed with DocValues?
boolean	hasXmlTags()
String	name() Get this field's name
String	offsetsField() Get the Lucene field that contains character offsets (if any)
String	tokenLengthField()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Constructor Detail

MockAnnotatedField

public MockAnnotatedField(String name,
                          List<Annotation> annotations)

Method Detail

name

public String name()

Description copied from interface: Field

Get this field's name

Specified by:

name in interface Field

Returns:

this field's name

displayName

public String displayName()

Description copied from interface: Field

Get this field's display name

Specified by:

displayName in interface Field

Returns:

this field's display name

description

public String description()

Description copied from interface: Field

Get this field's display name

Specified by:

description in interface Field

Returns:

this field's display name

hasContentStore

public boolean hasContentStore()

Description copied from interface: Field

Is this field's content stored in a content store?

Specified by:

hasContentStore in interface Field

Returns:

true if it does, false if not

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

hasXmlTags

public boolean hasXmlTags()

Specified by:

hasXmlTags in interface AnnotatedField

hasPunctuationForwardIndex

public boolean hasPunctuationForwardIndex()

Specified by:

hasPunctuationForwardIndex in interface AnnotatedField

tokenLengthField

public String tokenLengthField()

Specified by:

tokenLengthField in interface AnnotatedField

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