Class Explain


  • public class Explain
    extends java.lang.Object
    Search explain plan used in the Content Optimiser.
    Since:
    11.0
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Explain.Schema
      Constants to enable extracting the Explain data from the PADRE XML result packet tags.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      int consat
      The number of constraints this result satisfied
      java.util.Map<CoolerWeighting,​java.lang.Float> featureScores
      Map of float scores for each ranking feature.
      float finalScore
      The final score for this result
      float lenratio
      The length ratio of this document relative to the average document, measured in content words
    • Constructor Summary

      Constructors 
      Constructor Description
      Explain()  
      Explain​(float finalScore, int consat, float lenratio, java.util.Map<CoolerWeighting,​java.lang.Float> featureScores)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getConsat()
      The number of constraints this result satisfied
      java.util.Map<CoolerWeighting,​java.lang.Float> getFeatureScores()
      Map of float scores for each ranking feature.
      float getFinalScore()
      The final score for this result
      float getLenratio()
      The length ratio of this document relative to the average document, measured in content words
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • finalScore

        public float finalScore
        The final score for this result
      • consat

        public int consat
        The number of constraints this result satisfied
      • lenratio

        public float lenratio
        The length ratio of this document relative to the average document, measured in content words
      • featureScores

        public java.util.Map<CoolerWeighting,​java.lang.Float> featureScores

        Map of float scores for each ranking feature.

        Feature names are specified by their unique short name + id.

    • Constructor Detail

      • Explain

        public Explain()
      • Explain

        public Explain​(float finalScore,
                       int consat,
                       float lenratio,
                       java.util.Map<CoolerWeighting,​java.lang.Float> featureScores)
    • Method Detail

      • getFinalScore

        public float getFinalScore()
        The final score for this result
      • getConsat

        public int getConsat()
        The number of constraints this result satisfied
      • getLenratio

        public float getLenratio()
        The length ratio of this document relative to the average document, measured in content words
      • getFeatureScores

        public java.util.Map<CoolerWeighting,​java.lang.Float> getFeatureScores()

        Map of float scores for each ranking feature.

        Feature names are specified by their unique short name + id.