Package org.rcsb.strucmotif.domain.result

Class MotifSearchResult

java.lang.Object
org.rcsb.strucmotif.domain.result.MotifSearchResult
public class MotifSearchResult extends Object
The state and results of a motif search run.

  • Constructor Details

    • MotifSearchResult

      public MotifSearchResult(MotifSearchQuery query)
      Construct a result container.
      Parameters:
      query - the initial query

  • Method Details

    • getQuery

      public MotifSearchQuery getQuery()
      The initial query.
      Returns:
      a query

    • getTimings

      public Timings getTimings()
      Associated timings.
      Returns:
      timings object

    • getTargetStructures

      public Map<String,TargetStructure> getTargetStructures()
      Access to all currently referenced target structures.
      Returns:
      a map with structure identifiers as keys and target structure instances as values

    • setTargetStructures

      public void setTargetStructures(Map<String,TargetStructure> targetStructures)
      Update the currently referenced target structures.
      Parameters:
      targetStructures - a map with structure identifiers as keys and target structure instances as values

    • setHits

      public void setHits(List<Hit> hits)
      Update the collection of currently valid hits.
      Parameters:
      hits - a collection of hits

    • getHits

      public List<Hit> getHits()
      Access all (currently) valid hits.
      Returns:
      a collection of hits

    • setNumberOfPaths

      public void setNumberOfPaths(int numberOfPaths)
      Update the number of valid paths.
      Parameters:
      numberOfPaths - an int

    • getNumberOfPaths

      public int getNumberOfPaths()
      The number of valid paths in all target structures.
      Returns:
      an int

    • setNumberOfTargetStructures

      public void setNumberOfTargetStructures(int numberOfTargetStructures)
      Update the number of referenced target structures.
      Parameters:
      numberOfTargetStructures - an int

    • getNumberOfTargetStructures

      public int getNumberOfTargetStructures()
      The number of referenced target structures.
      Returns:
      an int

    • incrementAndGetPathGeneration

      public int incrementAndGetPathGeneration()
      Called internally after a descriptor has been processed.
      Returns:
      the new path generation