Interface Engine

All Known Implementing Classes:
EngineImpl, JSONEngine, PluginEngine, RegexEngine, RSSEngine, WebEngine

public interface Engine
  • Field Details

  • Method Details

    • getType

      int getType()
    • search

      Result[] search(SearchParameter[] searchParameters, Map context, int desired_max_matches, int absolute_max_matches, String headers, ResultListener listener) throws SearchException
      Throws:
      SearchException
    • getName

      String getName()
    • getNameEx

      String getNameEx()
    • getId

      long getId()
    • getUID

      String getUID()
    • getVersion

      int getVersion()
    • getLastUpdated

      long getLastUpdated()
    • getIcon

      String getIcon()
    • getDownloadLinkCSS

      String getDownloadLinkCSS()
    • isActive

      boolean isActive()
    • isMine

      boolean isMine()
    • isPublic

      boolean isPublic()
    • setMine

      void setMine(boolean mine)
    • getSelectionState

      int getSelectionState()
    • setSelectionState

      void setSelectionState(int state)
    • recordSelectionState

      void recordSelectionState()
    • checkSelectionStateRecorded

      void checkSelectionStateRecorded()
    • getSource

      int getSource()
    • setSource

      void setSource(int source)
    • getReferer

      String getReferer()
    • getRankBias

      float getRankBias()
    • setRankBias

      void setRankBias(float bias)
    • setPreferredDelta

      void setPreferredDelta(float delta)
    • getPreferredWeighting

      float getPreferredWeighting()
    • applyRankBias

      float applyRankBias(float rank)
    • supportsField

      boolean supportsField(int field_id)
    • supportsContext

      boolean supportsContext(String context_key)
    • isShareable

      boolean isShareable()
    • isAnonymous

      boolean isAnonymous()
    • isAuthenticated

      boolean isAuthenticated()
    • getAutoDownloadSupported

      int getAutoDownloadSupported()
      Returns:
      one of AUTO_DL constants above
    • getAZVersion

      int getAZVersion()
    • addPotentialAssociation

      void addPotentialAssociation(String key)
    • getSubscription

      Subscription getSubscription()
    • exportToBencodedMap

      Map<String,Object> exportToBencodedMap() throws IOException
      Throws:
      IOException
    • exportToBencodedMap

      Map<String,Object> exportToBencodedMap(boolean generic) throws IOException
      Throws:
      IOException
    • exportToJSONString

      String exportToJSONString() throws IOException
      Throws:
      IOException
    • exportToVuzeFile

      void exportToVuzeFile(File target) throws IOException
      Throws:
      IOException
    • exportToVuzeFile

      VuzeFile exportToVuzeFile() throws IOException
      Throws:
      IOException
    • sameLogicAs

      boolean sameLogicAs(Engine other)
      Tests for sameness in terms of function (ignores id, selection state etc)
      Parameters:
      other -
      Returns:
    • reset

      void reset()
      resets to initial state (e.g. if the engine has state pertaining to what has/hasn't been downloaded such as etags then this will be cleared)
    • delete

      void delete()
    • getString

      String getString()