Interface BioSQLFeatureFilter

All Superinterfaces:
FeatureFilter, Serializable
All Known Implementing Classes:
BioSQLAcceptAllFilter, BioSQLAcceptNoneFilter, BioSQLFeatureFilter.And, BioSQLFeatureFilter.ByName, BioSQLFeatureFilter.ByNote, BioSQLFeatureFilter.ByNoteTermOnly, BioSQLFeatureFilter.ByRank, BioSQLFeatureFilter.BySequenceName, BioSQLFeatureFilter.BySourceTerm, BioSQLFeatureFilter.BySourceTermName, BioSQLFeatureFilter.ByStrand, BioSQLFeatureFilter.ByTypeTerm, BioSQLFeatureFilter.ByTypeTermName, BioSQLFeatureFilter.ContainedByRichLocation, BioSQLFeatureFilter.HibernateFeatureFilter, BioSQLFeatureFilter.Not, BioSQLFeatureFilter.Or, BioSQLFeatureFilter.OverlapsRichLocation

public interface BioSQLFeatureFilter extends FeatureFilter
A filter for accepting or rejecting a feature.

It is possible to write custom FeatureFilters by implementing this interface. There are also a wide range of built-in features, and it is possible to build complex queries using FeatureFilter.And, FeatureFilter.Or, and FeatureFilter.Not. Where possible, use of the built-in filters is preferable to writing new filters, since the methods in the FilterUtils class have access to special knowledge about the built-in filter types and how they relate to one another.

If the filter is to be used in a remote process, it is recognized that it may be serialized and sent over to run remotely, rather than each feature being retrieved locally.

This class requires the Hibernate JAR files to be on your classpath at runtime. It is designed ONLY for use with BioSQLRichSequenceDB and BioSQLBioEntryDB.

Since:
1.5, 1.5
Author:
Matthew Pocock, Thomas Down, Richard Holland
  • Field Details

  • Method Details

    • asCriterion

      This method returns a Hibernate Criterion object that can be used to query the database.
      Returns:
      a Hibernate Criterion object representing this filter.
    • criterionAliasMap

      Returns a map of property names (keys) to aliases (values), if the criterion returned by asCriterion() uses aliases at all. If not, then it must at least return the empty map else you'll get NullPointerExceptions thrown elsewhere.
      Returns:
      Map a map of property names to aliases used in the criterion.