Class Derived
- java.lang.Object
-
- com.yahoo.searchdefinition.derived.Derived
-
- All Implemented Interfaces:
Exportable
- Direct Known Subclasses:
AttributeFields
,ImportedFields
,IndexInfo
,IndexingScript
,IndexSchema
,Juniperrc
,RankProfileList
,Summaries
,SummaryClass
,SummaryMap
,VsmFields
,VsmSummary
public abstract class Derived extends java.lang.Object implements Exportable
Superclass of all derived configurations- Author:
- bratseth
-
-
Constructor Summary
Constructors Constructor Description Derived()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
derive(ImmutableSDField field, Search search)
Derives the content of this configuration.protected void
derive(SDDocumentType document, Search search)
Derives the content of this configuration.protected void
derive(Index index, Search search)
Derives the content of this configuration.protected void
derive(Search search)
Derives the content of this configuration.void
export(java.lang.String toDirectory)
Exports this derived configuration to its .cfg file in toDirectoryprotected abstract java.lang.String
getDerivedName()
java.lang.String
getFileName()
The (short) name of the exported fileprotected java.lang.String
getIndex(int number, boolean labels)
Returns the value of getName if true, the given number as a string otherwisejava.lang.String
getName()
protected void
setName(java.lang.String name)
-
-
-
Method Detail
-
getName
public java.lang.String getName()
-
setName
protected final void setName(java.lang.String name)
-
derive
protected void derive(Search search)
Derives the content of this configuration. This default calls derive(Document) for each document and derive(SDField) for each search definition level field AND sets the name of this to the name of the input search definition
-
derive
protected void derive(SDDocumentType document, Search search)
Derives the content of this configuration. This default calls derive(SDField) for each document field
-
derive
protected void derive(ImmutableSDField field, Search search)
Derives the content of this configuration. This default does nothing.
-
derive
protected void derive(Index index, Search search)
Derives the content of this configuration. This default does nothing.
-
getDerivedName
protected abstract java.lang.String getDerivedName()
-
getIndex
protected java.lang.String getIndex(int number, boolean labels)
Returns the value of getName if true, the given number as a string otherwise
-
export
public final void export(java.lang.String toDirectory) throws java.io.IOException
Exports this derived configuration to its .cfg file in toDirectory- Specified by:
export
in interfaceExportable
- Parameters:
toDirectory
- the directory to export to, or null- Throws:
java.io.IOException
- if exporting fails, some files may still be created
-
getFileName
public java.lang.String getFileName()
Description copied from interface:Exportable
The (short) name of the exported file- Specified by:
getFileName
in interfaceExportable
- Returns:
- a String with the (short) name of the exported file
-
-