Package com.yahoo.schema.derived

Class Derived

java.lang.Object
com.yahoo.schema.derived.Derived
All Implemented Interfaces:
Exportable
Direct Known Subclasses:
AttributeFields, ImportedFields, IndexInfo, IndexingScript, IndexSchema, Juniperrc, RankProfileList, SchemaInfo, Summaries, SummaryClass, VsmFields, VsmSummary
public abstract class Derived extends Object implements Exportable
Superclass of all derived configurations
Author:
bratseth

  • Constructor Details

    • Derived

      public Derived()

    • Derived

      public Derived(String name)

  • Method Details

    • getName

      public String getName()

    • setName

      protected final void setName(String name)

    • derive

      protected void derive(Schema schema)
      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, Schema schema)
      Derives the content of this configuration. This default calls derive(SDField) for each document field

    • derive

      protected void derive(ImmutableSDField field, Schema schema)
      Derives the content of this configuration. This default does nothing.

    • derive

      protected void derive(Index index, Schema schema)
      Derives the content of this configuration. This default does nothing.

    • getDerivedName

      protected abstract String getDerivedName()

    • getIndex

      protected 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(String toDirectory) throws IOException
      Exports this derived configuration to its .cfg file in toDirectory
      Specified by:
      export in interface Exportable
      Parameters:
      toDirectory - the directory to export to, or null
      Throws:
      IOException - if exporting fails, some files may still be created

    • getFileName

      public String getFileName()
      Description copied from interface: Exportable
      The (short) name of the exported file
      Specified by:
      getFileName in interface Exportable
      Returns:
      a String with the (short) name of the exported file