JPath

A high-level interface for walking down a tree defined by a com.rojoma.json.ast.JValue, returning a set of sub-values that match a path defined by a series of steps.

Example:

val v = JsonReader.fromString("""
  {
     "array": [1,2,3],
     "object": {
       "France" : [ "Paris", "Lyon", "Bordeaux" ],
       "Germany" : [ "Berlin", "Munich", "Leipzig" ],
       "Italy" : [ "Rome", "Florence", "Milan" ]
     }
  }
""")

def contains(z: JsonZipper, s: String) =
  z.asArray.map(_.value.toSeq.contains(JString(s))).getOrElse(false)

JPath(v).down("array").finish
   // --> Stream(JArray(JNumber(1), JNumber(2), JNumber(3)))
JPath(v).down("object").*.downFirst.finish
   // --> Stream(JString("Paris"), JString("Berlin"), JString("Rome"))
JPath(v).*.down("France").downFirst.finish
   // --> Stream(JString("Paris"))
JPath(v).**.downFirst.finish
  // --> Stream(JNumber(1), JString("Paris"), JString("Berlin"), JString("Rome"))
JPath(v).*.having(_.*.where(contains(_, "Lyon"))).finish
  // --> Stream(JObject("France" -> ..., "Germany" -> ..., "Italy" -> ...))
JPath(v).*.*.where(contains(_, "Lyon")).finish
  // --> Stream(JArray(JString("Paris"), JString("Lyon"), JString("Bordeaux")))

Linear Supertypes

AnyRef, Any

Instance Constructors

new JPath(input: JValue)

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
def *: JPath

Go down into all children, whether fields or array elements.
Go down into all children, whether fields or array elements. If a current point is not a com.rojoma.json.ast.JObject or com.rojoma.json.ast.JArray, it is dropped.
def **: JPath

Go down (as by *) and then add every descendant of the current points to the set of points (as by rec).
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def down(target: Int): JPath

Go down into the given index.
Go down into the given index. If a current point is not a com.rojoma.json.ast.JArray, or does not contain the index, it is dropped.
def down(target: String): JPath

Go down into the named field.
Go down into the named field. If a current point is not a com.rojoma.json.ast.JObject, or does not contain the field, it is dropped.
def downFirst: JPath

Go down into the first child of an array.
Go down into the first child of an array. If a current point is not a com.rojoma.json.ast.JArray, it is dropped.
def downLast: JPath

Go down into the last child of an array.
Go down into the last child of an array. If a current point is not a com.rojoma.json.ast.JArray, it is dropped.
def downWhere(pred: (JsonZipper) ⇒ Boolean): JPath

Go down into all children (as by *) and then filter by a predicate (as by where).
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def finish: Stream[JValue]

Produce a Stream of com.rojoma.json.ast.JValues, one for each current point.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def having(pred: (JPath) ⇒ JPath): JPath

Filter the current set of points by applying another JPath operation to them and keeping only the ones that ended up with a non-empty set of results.
Filter the current set of points by applying another JPath operation to them and keeping only the ones that ended up with a non-empty set of results.
This is basically mark-and-return. E.g.,
```
x.having(_.down("foo").*.where(isNumberGreaterThan(5)))
```
is the same as:
```
x.down("foo").*.where(isNumberGreaterThan(5)).up.up
```
but also works if one of the inner steps is "rec", where no fixed number of final up steps would suffice.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def next: JPath

Move to the next sibling.
Move to the next sibling. Any points that were at the end already, or which were not children of com.rojoma.json.ast.JArrays, will be dropped.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def prev: JPath

Move to the previous sibling.
Move to the previous sibling. Any points that were at the start already, or which were not children of com.rojoma.json.ast.JArrays, will be dropped.
def rec: JPath

Add every descendant of the current points to the set of points.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def up: JPath

Go up to the parents of the current points.
Go up to the parents of the current points. Any that were already at the top of the tree will be dropped.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def where(pred: (JsonZipper) ⇒ Boolean): JPath

Filter the set of current points by a predicate.

class JPath extends AnyRef

Instance Constructors

new JPath(input: JValue)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def *: JPath

def **: JPath

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def down(target: Int): JPath

def down(target: String): JPath

def downFirst: JPath

def downLast: JPath

def downWhere(pred: (JsonZipper) ⇒ Boolean): JPath

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def finish: Stream[JValue]

final def getClass(): Class[_]

def hashCode(): Int

def having(pred: (JPath) ⇒ JPath): JPath

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

def next: JPath

final def notify(): Unit

final def notifyAll(): Unit

def prev: JPath

def rec: JPath

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def up: JPath

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def where(pred: (JsonZipper) ⇒ Boolean): JPath

Inherited from AnyRef

Inherited from Any

Ungrouped