net.liftweb.couchdb

AllDocs

trait AllDocs extends Request with Queryable[AllDocs]

Trait of requests representing all documents in a Couch database

linear super types: Queryable[AllDocs], Request, Handlers, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. AllDocs
  2. Queryable
  3. Request
  4. Handlers
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def / (path: String) : Request

    definition classes: Request
  7. def <& (req: Request) : Request

    definition classes: Request
  8. def <:< (values: Map[String, String]) : Request

    definition classes: Request
  9. def << (string_body: String) : Request

    definition classes: Request
  10. def << (values: Map[String, Any]) : Request

    definition classes: Request
  11. def <<< (file: File, content_type: String) : Request

    definition classes: Request
  12. def <<< (body: String) : Request

    definition classes: Request
  13. def <<? (values: Map[String, Any]) : Request

    definition classes: Request
  14. def <> [T] (block: (Elem) ⇒ T) : Handler[T]

    definition classes: Handlers
  15. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  16. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  17. def >& [T] (other: Handler[T]) : Handler[T]

    definition classes: Request
  18. def >+ [A, B] (block: (Handlers) ⇒ (Handler[A], Handler[B])) : Handler[(A, B)]

    definition classes: Handlers
  19. def >+> [T] (block: (Handlers) ⇒ Handler[Handler[T]]) : Handler[T]

    definition classes: Handlers
  20. def >- [T] (block: (String) ⇒ T) : Handler[T]

    definition classes: Handlers
  21. def >:> [T] (block: (Map[String, Set[String]]) ⇒ T) : Handler[T]

    definition classes: Handlers
  22. def >> [T] (block: (InputStream) ⇒ T) : Handler[T]

    definition classes: Handlers
  23. def >> [T] (block: (InputStream, String) ⇒ T) : Handler[T]

    definition classes: Handlers
  24. def >>> [OS <: OutputStream] (out: OS) : Handler[OS]

    definition classes: Handlers
  25. def >\ (charset: String) : Request

    definition classes: Request
  26. def >| : Handler[Unit]

    definition classes: Handlers
  27. def >~ [T] (block: (Source) ⇒ T) : Handler[T]

    definition classes: Handlers
  28. def DELETE : Request

    definition classes: Request
  29. def HEAD : Request

    definition classes: Request
  30. def POST : Request

    definition classes: Request
  31. def arrayRange (prefix: List[JValue]) : AllDocs

    Query a range matching the given key prefix.

    Query a range matching the given key prefix. Equivalent to composing from(prefix) and to(prefix with {} appended), e.g. from=["foobar"]&to=["foobar",{}]

    definition classes: Queryable
  32. def as (name: String, pass: String) : Request

    definition classes: Request
  33. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  34. def as_! (name: String, pass: String) : Request

    definition classes: Request
  35. def as_source : Handler[Source]

    definition classes: Handlers
  36. def as_str : Handler[String]

    definition classes: Handlers
  37. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  38. val creds : Option[Credentials]

    definition classes: Request
  39. val defaultCharset : String

    definition classes: Request
  40. def descending : AllDocs

    Specify a descending sort.

    Specify a descending sort. Note that the reversal is applied before key filtering, so you must reverse your from(...) and to(...) values.

    definition classes: Queryable
  41. def dontReduce : AllDocs

    Specify that reduction should not occur

    Specify that reduction should not occur

    definition classes: Queryable
  42. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  43. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  44. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  45. def from (lowValue: JValue, docid: String) : AllDocs

    Restrict the query to only keys greater than or equal to the given key, not including any documents that are earlier in the view than the given docid

    Restrict the query to only keys greater than or equal to the given key, not including any documents that are earlier in the view than the given docid

    definition classes: Queryable
  46. def from (lowValue: JValue) : AllDocs

    Restrict the query to only keys greater than or equal to the given key

    Restrict the query to only keys greater than or equal to the given key

    definition classes: Queryable
  47. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  48. def group (level: Int) : AllDocs

    Group results at the given level (see http://wiki.

    Group results at the given level (see http://wiki.apache.org/couchdb/Introduction_to_CouchDB_views)

    definition classes: Queryable
  49. def group : AllDocs

    Group results (see http://wiki.

    Group results (see http://wiki.apache.org/couchdb/Introduction_to_CouchDB_views)

    definition classes: Queryable
  50. def gzip : Request

    definition classes: Request
  51. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  52. val host : Option[HttpHost]

    definition classes: Request
  53. def includeDocs : AllDocs

    Include the associated document with each result

    Include the associated document with each result

    definition classes: Queryable
  54. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  55. def key (keyValue: JValue) : AllDocs

    Query for the given key only

    Query for the given key only

    definition classes: Queryable
  56. def keys (keyValues: JValue*) : AllDocs

    Query for the given set of keys

    Query for the given set of keys

    definition classes: Queryable
  57. def limit (i: Int) : AllDocs

    Limit the query to the given number of results

    Limit the query to the given number of results

    definition classes: Queryable
  58. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  59. def newQueryable (req: Request) : AllDocs

    Create a new self-typed instance

    Create a new self-typed instance

    attributes: protected
    definition classes: AllDocsQueryable
  60. def next (xf: Xf) : Request

    definition classes: Request
  61. def next_uri (sxf: (String) ⇒ String) : Request

    definition classes: Request
  62. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  63. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  64. def query : Handler[Box[QueryResults]]

    Fetch results of the query

    Fetch results of the query

    definition classes: Queryable
  65. def req : HttpRequestBase

    definition classes: Request
  66. val request : Request

    definition classes: Request → Handlers
  67. def secure : Request

    definition classes: Request
  68. def staleOk : AllDocs

    Specify that stale view data is okay.

    Specify that stale view data is okay. Used for optimization -- some other query must keep the view fresh.

    definition classes: Queryable
  69. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  70. def to (highValue: JValue, docid: String) : AllDocs

    Restrict the query to only keys less than or equal to the given key, not including any documents that are later in the view than the given docid

    Restrict the query to only keys less than or equal to the given key, not including any documents that are later in the view than the given docid

    definition classes: Queryable
  71. def to (highValue: JValue) : AllDocs

    Restrict the query to only keys less than or equal to the given key

    Restrict the query to only keys less than or equal to the given key

    definition classes: Queryable
  72. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  73. def to_uri : URI

    definition classes: Request
  74. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  75. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  76. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  77. def withParams (params: Map[String, Any]) : AllDocs

    Add parameters to the query

    Add parameters to the query

    definition classes: Queryable
  78. val xfs : List[Xf]

    definition classes: Request

Inherited from Queryable[AllDocs]

Inherited from Request

Inherited from Handlers

Inherited from AnyRef

Inherited from Any