Contents

module Documentation
  module Searchers
    class Abstract
      
      attr_reader :options
      
      def initialize(options = {})
        @options = options
        setup
      end
      
      #
      # Run whatever initial set up is needed
      #
      def setup
      end
      
      #
      # Search for a page from the index
      #
      def search(query, options = {})
        []
      end
      
      #
      # Delete a page from the index
      #
      def delete(page)
        false
      end
      
      #
      # Reset an index to have no data within it
      #
      def reset
        true
      end
      
      #
      # Add or update an page in the index
      #
      def index(page)
      end
      
    end
  end
end

Version data entries

11 entries across 11 versions & 2 rubygems

Version	Path
documentation-1.0.9	lib/documentation/searchers/abstract.rb
documentation-1.0.8	lib/documentation/searchers/abstract.rb
documentation-1.0.7	lib/documentation/searchers/abstract.rb
documentation-1.0.6	lib/documentation/searchers/abstract.rb
local_documentation-1.0.0	lib/documentation/searchers/abstract.rb
documentation-1.0.5	lib/documentation/searchers/abstract.rb
documentation-1.0.4	lib/documentation/searchers/abstract.rb
documentation-1.0.3	lib/documentation/searchers/abstract.rb
documentation-1.0.2	lib/documentation/searchers/abstract.rb
documentation-1.0.1	lib/documentation/searchers/abstract.rb
documentation-1.0.0	lib/documentation/searchers/abstract.rb