Module: Endeca

Extended by:
Benchmarking, Logging
Defined in:
lib/endeca.rb,
lib/endeca/map.rb,
lib/endeca/logging.rb,
lib/endeca/readers.rb,
lib/endeca/request.rb,
lib/endeca/document.rb,
lib/endeca/dimension.rb,
lib/endeca/breadcrumb.rb,
lib/endeca/refinement.rb,
lib/endeca/breadcrumbs.rb,
lib/endeca/transformer.rb,
lib/endeca/benchmarking.rb,
lib/endeca/document_collection.rb,
lib/endeca/refinement_dimension.rb

Defined Under Namespace

Modules: Benchmarking, Breadcrumbs, Logging, Readers, Transformer Classes: Breadcrumb, Dimension, Document, DocumentCollection, Map, ReaderError, Refinement, RefinementDimension, Request, RequestError

Constant Summary collapse

VERSION =

:stopdoc:

'1.3.7'

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Benchmarking

bm, increase_metric

Methods included from Logging

log

Class Attribute Details

.benchmark ⇒ Object

Returns the value of attribute benchmark.



42
43
44
 
# File 'lib/endeca.rb', line 42

def benchmark
  @benchmark
end

.debug ⇒ Object

Returns the value of attribute debug.



41
42
43
 
# File 'lib/endeca.rb', line 41

def debug
  @debug
end

.logger ⇒ Object

Returns the value of attribute logger.



40
41
42
 
# File 'lib/endeca.rb', line 40

def logger
  @logger
end

.timeout ⇒ Object

Returns the value of attribute timeout.



43
44
45
 
# File 'lib/endeca.rb', line 43

def timeout
  @timeout
end

Class Method Details

.analyze? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/endeca.rb', line 45

def analyze?
  debug && logger && benchmark
end

.escape(str) ⇒ Object

Endeca URIs require colons to be escaped



71
72
73
 
# File 'lib/endeca.rb', line 71

def self.escape(str)
  URI.escape(str, /[^-_.!~*'()a-zA-Z\d;\/?@&=+$,\[\]]/n)
end

.timer ⇒ Object 



49
50
51
 
# File 'lib/endeca.rb', line 49

def timer
  @timer ||= get_timer
end

.version ⇒ Object

Returns the version string for the library.



33
34
35
 
# File 'lib/endeca.rb', line 33

def self.version
  VERSION
end