org.qbproject.schema

QBSchemaOps

class QBSchemaOps extends QBBaseSchemaOps

Linear Supertypes
QBBaseSchemaOps, AnyRef, Any
Known Subclasses
QBSchema
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. QBSchemaOps
  2. QBBaseSchemaOps
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new QBSchemaOps()

Type Members

  1. case class BuildDescription(descriptions: List[(QBClass, String)]) extends Product with Serializable

    Definition Classes
    QBBaseSchemaOps

  2. implicit class QBFieldExtensionOps extends AnyRef

    Definition Classes
    QBBaseSchemaOps

  3. implicit class QBSchemaOps extends AnyRef

    Schema Ops Extensions ----------------------------------------------------------

  4. type QBStringPath = List[String]

    Definition Classes
    QBBaseSchemaOps

Value Members

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

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. object BuildDescription extends Serializable

    Definition Classes
    QBBaseSchemaOps

  7. def adaptSchema[A](schema: QBType, path: JsPath, adapter: (JsPath, QBType) ⇒ JsResult[JsValue]): JsResult[JsValue]

    Definition Classes
    QBBaseSchemaOps

  8. def add(schema: QBClass)(path: QBStringPath, attributes: Seq[QBAttribute]): QBClass

    Adds the given fields to the object located at the path of the given object.

    Adds the given fields to the object located at the path of the given object.

    schema

    the schema to which the attributes should be added

    path

    the path within the given schema at which the attributes should be added

    attributes

    the actual attributes to be added

    Definition Classes
    QBBaseSchemaOps

  9. def areEqual(schema: QBClass, otherSchema: QBClass): Boolean

    Compares the schema with each other

    Compares the schema with each other

    schema

    the schema to be compared

    otherSchema

    the schema to be compared against the first one

    returns

    true, if the schemas are equal, false otherwise

    Definition Classes
    QBBaseSchemaOps

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  11. def attribute(obj: QBClass, fieldName: String): QBAttribute

    Definition Classes
    QBBaseSchemaOps

  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  13. def collapse[A <: QBType, B](obj: QBClass)(modifier: (QBAttribute) ⇒ B)(implicit arg0: ClassTag[A], arg1: Monoid[B]): B

    Definition Classes
    QBBaseSchemaOps

  14. def collapseWithPath[B](matcher: (QBType) ⇒ Boolean)(obj: QBClass)(modifier: (QBAttribute, JsPath) ⇒ B)(implicit arg0: Monoid[B]): B

    Definition Classes
    QBBaseSchemaOps

  15. def emptyPath: QBStringPath

    Definition Classes
    QBBaseSchemaOps

  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  18. def extract(obj1: QBClass, obj2: QBClass): QBClass

    Removes all attributes from the first schema that are also part of the second given schema.

    Removes all attributes from the first schema that are also part of the second given schema.

    Definition Classes
    QBBaseSchemaOps

  19. def fail[A](msg: String): Nothing

    Definition Classes
    QBBaseSchemaOps

  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  24. def isSubSet(subSchema: QBClass, schema: QBClass): Boolean

    Checks whether the schema is a subset of the given schema.

    Checks whether the schema is a subset of the given schema.

    subSchema

    the schema that is supposed to be a subset

    schema

    the schema to check the sub schema against

    returns

    true, if the sub schema is a subset of the schema

    Definition Classes
    QBBaseSchemaOps

  25. def makeOptional(root: QBClass, paths: List[QBStringPath]): QBClass

    Makes all values referenced by the given list of paths optional.

    Makes all values referenced by the given list of paths optional.

    Definition Classes
    QBBaseSchemaOps

  26. def makeReadOnly(schema: QBClass, paths: List[QBStringPath]): QBClass

    Marks all values referenced by the given list of paths as read-only.

    Marks all values referenced by the given list of paths as read-only.

    schema

    the schema that is supposed to contain the attributes that are referenced by the given paths

    returns

    the updated schema with the referenced attributes being marked as read-only

    Definition Classes
    QBBaseSchemaOps

  27. def merge(schema: QBClass, otherSchema: QBClass): QBClass

    Merges the attributes of the second schema into the first one.

    Merges the attributes of the second schema into the first one.

    schema

    the target schema

    otherSchema

    the schema to be merged into the target schema

    Definition Classes
    QBBaseSchemaOps

  28. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  29. final def notify(): Unit

    Definition Classes
    AnyRef

  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  31. def pathOfSubSchema(schema: QBClass, subSchema: QBClass): Option[String]

    Returns the path of the given subschema, if it is contained in the schema.

    Returns the path of the given subschema, if it is contained in the schema.

    schema

    the schema that is supposed to contain the sub-schema

    subSchema

    the sub-schema that is supposed to be contained in the first schema

    returns

    the path of sub-schema in the schema, if it is contained, None otherwise

    Definition Classes
    QBBaseSchemaOps

  32. def remove(schema: QBClass, paths: Seq[QBStringPath]): QBClass

    Removes all values that are referenced by the list of paths within the given object.

    Removes all values that are referenced by the list of paths within the given object.

    schema

    the schema from which to remove attributes

    paths

    the paths to the attributes that are to be removed

    Definition Classes
    QBBaseSchemaOps

  33. def renameAttribute(root: QBClass)(path: QBStringPath, newFieldName: String): QBClass

    Renames the field located at the given path.

    Renames the field located at the given path.

    Example: Given an schema obj("a" -> obj("b" -> integer)) rename(List("a","b"), "c") will change the object to obj("a" -> obj("c" -> integer)).

    Definition Classes
    QBBaseSchemaOps

  34. def resolve(path: QBStringPath, resolvable: QBClass): (BuildDescription, QBType)

    Resolves the given path starting from the given resolvable.

    Resolves the given path starting from the given resolvable.

    Definition Classes
    QBBaseSchemaOps

  35. def resolvePath[A <: QBType](obj: QBClass)(path: QBStringPath): A

    Resolves the given path.

    Resolves the given path.

    Definition Classes
    QBBaseSchemaOps

  36. def retain(root: QBClass)(path: QBStringPath, fields: Seq[String]): QBClass

    Retains all fields of the object at the given path based on the name of the fields.

    Retains all fields of the object at the given path based on the name of the fields.

    Definition Classes
    QBBaseSchemaOps

  37. implicit def string2QBPath(str: String): QBStringPath

    Definition Classes
    QBBaseSchemaOps

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

    Definition Classes
    AnyRef

  39. def toQBPaths(paths: List[String]): List[QBStringPath]

    Definition Classes
    QBBaseSchemaOps

  40. def toString(): String

    Definition Classes
    AnyRef → Any

  41. def update(qbType: QBType)(predicate: (QBType) ⇒ Boolean)(modifier: (QBType) ⇒ QBType): QBType

    Definition Classes
    QBBaseSchemaOps

  42. def update[A <: QBType](resolvable: QBClass, path: QBStringPath, updateFn: (A) ⇒ QBType): QBClass

    Resolves the given path on the given object, executes the modifier if the path has been resolved and returns the updated object.

    Resolves the given path on the given object, executes the modifier if the path has been resolved and returns the updated object.

    A

    the expected tyupe when the path is resolved

    resolvable

    the object which is supposed to contain an attribute path

    path

    the path that is to be followed through the object

    updateFn

    the update function

    returns

    the updated object

    Definition Classes
    QBBaseSchemaOps

  43. def updateAttributeByPath(root: QBClass)(path: QBStringPath, fn: (QBAttribute) ⇒ QBAttribute): QBClass

    Definition Classes
    QBBaseSchemaOps

  44. def updateAttributeByPredicate(qbType: QBType)(predicate: (QBAttribute) ⇒ Boolean)(modifier: (QBAttribute) ⇒ QBAttribute): QBType

    Definition Classes
    QBBaseSchemaOps

  45. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  47. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from QBBaseSchemaOps

Inherited from AnyRef

Inherited from Any

Ungrouped