Package com.yahoo.schema.document

Class ImmutableImportedSDField

java.lang.Object

com.yahoo.schema.document.ImmutableImportedSDField

All Implemented Interfaces:

ImmutableSDField

Direct Known Subclasses:

ImmutableImportedComplexSDField

public class ImmutableImportedSDField
extends Object
implements ImmutableSDField

Wraps ImportedField as ImmutableSDField. Methods that are not meaningful or relevant for imported fields will throw UnsupportedOperationException.

Author:

bjorncs

Method Summary

Modifier and Type	Method	Description
com.yahoo.document.Field	asField()	Returns a field representation of the imported field.
<T extends com.yahoo.vespa.indexinglanguage.expressions.Expression> boolean	containsExpression(Class<T> searchFor)
boolean	doesAttributing()
boolean	doesBitPacking()
boolean	doesIndexing()
boolean	doesLowerCasing()
boolean	existsIndex(String name)
Map<String,String>	getAliasToName()
Attribute	getAttribute()
Map<String,Attribute>	getAttributes()
com.yahoo.document.DataType	getDataType()
ImportedField	getImportedField()
Index	getIndex(String name)
com.yahoo.vespa.indexinglanguage.expressions.ScriptExpression	getIndexingScript()
Map<String,Index>	getIndices()
int	getLiteralBoost()
Matching	getMatching()
String	getName()
NormalizeLevel	getNormalizing()
List<String>	getQueryCommands()
Ranking	getRanking()
RankType	getRankType()
Stemming	getStemming()
Stemming	getStemming(Schema schema)
ImmutableSDField	getStructField(String name)
Collection<? extends ImmutableSDField>	getStructFields()
SummaryField	getSummaryField(String name)
Map<String,SummaryField>	getSummaryFields()
int	getWeight()
boolean	hasFullIndexingDocprocRights()	Returns true if this is a document field (not a synthetic field), or a mutable attribute.
boolean	hasIndex()
boolean	hasSingleAttribute()	Returns whether this field has a single attribute with the same name as this field.
boolean	isExtraField()
boolean	isImportedField()
boolean	isIndexStructureField()
boolean	usesStructOrMap()
boolean	wasConfiguredToDoAttributing()	Whether this field at some time was configured to do attributing.
boolean	wasConfiguredToDoIndexing()	Whether this field at some time was configured to do indexing.

Methods inherited from class java.lang.Object

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

Method Details

getImportedField

public ImportedField getImportedField()

containsExpression

public <T extends com.yahoo.vespa.indexinglanguage.expressions.Expression>
boolean containsExpression(Class<T> searchFor)

Specified by:

containsExpression in interface ImmutableSDField

doesAttributing

public boolean doesAttributing()

Specified by:

doesAttributing in interface ImmutableSDField

doesIndexing

public boolean doesIndexing()

Specified by:

doesIndexing in interface ImmutableSDField

doesBitPacking

public boolean doesBitPacking()

Specified by:

doesBitPacking in interface ImmutableSDField

doesLowerCasing

public boolean doesLowerCasing()

Specified by:

doesLowerCasing in interface ImmutableSDField

isExtraField

public boolean isExtraField()

Specified by:

isExtraField in interface ImmutableSDField

isImportedField

public boolean isImportedField()

Specified by:

isImportedField in interface ImmutableSDField

isIndexStructureField

public boolean isIndexStructureField()

Specified by:

isIndexStructureField in interface ImmutableSDField

hasIndex

public boolean hasIndex()

Specified by:

hasIndex in interface ImmutableSDField

usesStructOrMap

public boolean usesStructOrMap()

Specified by:

usesStructOrMap in interface ImmutableSDField

wasConfiguredToDoAttributing

public boolean wasConfiguredToDoAttributing()

Description copied from interface: ImmutableSDField

Whether this field at some time was configured to do attributing. This function can typically return a different value than doesAttributing(), which uses the final state of the underlying indexing script instead.

Specified by:

wasConfiguredToDoAttributing in interface ImmutableSDField

wasConfiguredToDoIndexing

public boolean wasConfiguredToDoIndexing()

Description copied from interface: ImmutableSDField

Whether this field at some time was configured to do indexing. This function can typically return a different value than doesIndexing(), which uses the final state of the underlying indexing script instead.

Specified by:

wasConfiguredToDoIndexing in interface ImmutableSDField

hasSingleAttribute

public boolean hasSingleAttribute()

Description copied from interface: ImmutableSDField

Returns whether this field has a single attribute with the same name as this field.

Specified by:

hasSingleAttribute in interface ImmutableSDField

getDataType

public com.yahoo.document.DataType getDataType()

Specified by:

getDataType in interface ImmutableSDField

getSummaryField

public SummaryField getSummaryField(String name)

Specified by:

getSummaryField in interface ImmutableSDField

getIndex

public Index getIndex(String name)

Specified by:

getIndex in interface ImmutableSDField

getQueryCommands

public List<String> getQueryCommands()

Specified by:

getQueryCommands in interface ImmutableSDField

getAttributes

public Map<String,Attribute> getAttributes()

Specified by:

getAttributes in interface ImmutableSDField

getAttribute

public Attribute getAttribute()

Specified by:

getAttribute in interface ImmutableSDField

getAliasToName

public Map<String,String> getAliasToName()

Specified by:

getAliasToName in interface ImmutableSDField

getIndexingScript

public com.yahoo.vespa.indexinglanguage.expressions.ScriptExpression getIndexingScript()

Specified by:

getIndexingScript in interface ImmutableSDField

getMatching

public Matching getMatching()

Specified by:

getMatching in interface ImmutableSDField

getNormalizing

public NormalizeLevel getNormalizing()

Specified by:

getNormalizing in interface ImmutableSDField

getStructField

public ImmutableSDField getStructField(String name)

Specified by:

getStructField in interface ImmutableSDField

getStructFields

public Collection<? extends ImmutableSDField> getStructFields()

Specified by:

getStructFields in interface ImmutableSDField

getStemming

public Stemming getStemming()

Specified by:

getStemming in interface ImmutableSDField

getStemming

public Stemming getStemming(Schema schema)

Specified by:

getStemming in interface ImmutableSDField

getRanking

public Ranking getRanking()

Specified by:

getRanking in interface ImmutableSDField

getSummaryFields

public Map<String,SummaryField> getSummaryFields()

Specified by:

getSummaryFields in interface ImmutableSDField

getName

public String getName()

Specified by:

getName in interface ImmutableSDField

getWeight

public int getWeight()

Specified by:

getWeight in interface ImmutableSDField

getLiteralBoost

public int getLiteralBoost()

Specified by:

getLiteralBoost in interface ImmutableSDField

getRankType

public RankType getRankType()

Specified by:

getRankType in interface ImmutableSDField

getIndices

public Map<String,Index> getIndices()

Specified by:

getIndices in interface ImmutableSDField

existsIndex

public boolean existsIndex(String name)

Specified by:

existsIndex in interface ImmutableSDField

asField

public com.yahoo.document.Field asField()

Returns a field representation of the imported field. Changes to the returned instance are not propagated back to the underlying imported field!

Specified by:

asField in interface ImmutableSDField

hasFullIndexingDocprocRights

public boolean hasFullIndexingDocprocRights()

Description copied from interface: ImmutableSDField

Returns true if this is a document field (not a synthetic field), or a mutable attribute.

Specified by:

hasFullIndexingDocprocRights in interface ImmutableSDField