play.api.data.mapping.delimited

Rules

Related Doc: package delimited

object Rules extends DefaultRules[Delimited] with ParsingRules

Rules for parsing/validating/transforming Array[String] as typically returned from CSV parsers.

{{ case class Contact(name: String, email: String, birthday: Option[LocalDate])

val contactReads = From[Delimited] { => ( ( \ 0).read[String] and ( \ 1).read(email) and ( \ 2).read(optionR[LocalDate](equalTo("N/A"))) )(Contact)}

val csv1 = "Ian Hummel,[email protected],1981-07-24".split(",") val csv2 = "Jane Doe,[email protected],N/A".split(",")

contactReads.validate(csv1) // returns Success(Contact("Ian Hummel", "[email protected]", Some(new LocalDate(1981, 7, 24)))) contactReads.validate(csv2) // returns Success(Contact("Jane Doe", "[email protected]", None)) }}

Linear Supertypes
ParsingRules, DefaultRules[Delimited], DateRules, GenericRules, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Rules
  2. ParsingRules
  3. DefaultRules
  4. DateRules
  5. GenericRules
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef → Any

  4. implicit def arrayR[I, O](implicit arg0: ClassTag[O], r: RuleLike[I, O]): Rule[Seq[I], Array[O]]

    Definition Classes
    GenericRules

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  6. implicit def bigDecimal: Rule[String, BigDecimal]

    Definition Classes
    ParsingRules

  7. implicit def booleanR: Rule[String, Boolean]

    Definition Classes
    ParsingRules

  8. def checked[I](implicit b: RuleLike[I, Boolean]): Rule[I, Boolean]

    Definition Classes
    GenericRules

  9. def clone(): AnyRef

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

  10. def date(format: String, corrector: (String) ⇒ String): Rule[String, Date]

    Definition Classes
    DateRules

  11. implicit val date: Rule[String, Date]

    Definition Classes
    DateRules

  12. implicit def doubleR: Rule[String, Double]

    Definition Classes
    ParsingRules

  13. def email: Rule[String, String]

    Definition Classes
    GenericRules

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

    Definition Classes
    AnyRef

  15. def equalTo[T](t: T): Rule[T, T]

    Definition Classes
    GenericRules

  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  17. def finalize(): Unit

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

  18. implicit def floatR: Rule[String, Float]

    Definition Classes
    ParsingRules

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

    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  21. implicit def headAs[I, O](implicit c: RuleLike[I, O]): Rule[Seq[I], O]

    Definition Classes
    GenericRules

  22. def ignored[I, O](o: O): (Path) ⇒ Rule[I, O]

    Definition Classes
    GenericRules

  23. implicit def intR: Rule[String, Int]

    Definition Classes
    ParsingRules

  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  25. val isoDate: Rule[String, Date]

    Definition Classes
    DateRules

  26. implicit def javaBigDecimalR: Rule[String, BigDecimal]

    Definition Classes
    ParsingRules

  27. implicit val jodaDate: Rule[String, DateTime]

    Definition Classes
    DateRules

  28. def jodaDateRule(pattern: String, corrector: (String) ⇒ String): Rule[String, DateTime]

    Definition Classes
    DateRules

  29. implicit val jodaLocalDate: Rule[String, LocalDate]

    Definition Classes
    DateRules

  30. implicit def jodaLocalDateRule(pattern: String, corrector: (String) ⇒ String): Rule[String, LocalDate]

    Definition Classes
    DateRules

  31. implicit def jodaTime: Rule[Long, DateTime]

    Definition Classes
    DateRules

  32. implicit def listR[I, O](implicit r: RuleLike[I, O]): Rule[Seq[I], List[O]]

    Definition Classes
    GenericRules

  33. implicit def longR: Rule[String, Long]

    Definition Classes
    ParsingRules

  34. def mapR[K, O](r: RuleLike[K, O], p: RuleLike[Delimited, Seq[(String, K)]]): Rule[Delimited, Map[String, O]]

    Definition Classes
    DefaultRules

  35. def max[T](m: T)(implicit o: Ordering[T]): Rule[T, T]

    Definition Classes
    GenericRules

  36. def maxLength(l: Int): Rule[String, String]

    Definition Classes
    GenericRules

  37. def min[T](m: T)(implicit o: Ordering[T]): Rule[T, T]

    Definition Classes
    GenericRules

  38. def minLength(l: Int): Rule[String, String]

    Definition Classes
    GenericRules

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

    Definition Classes
    AnyRef

  40. def noConstraint[From]: Constraint[From]

    Definition Classes
    GenericRules

  41. def not[I, O](r: RuleLike[I, O]): Rule[I, I]

    Definition Classes
    GenericRules

  42. def notEmpty: Rule[String, String]

    Definition Classes
    GenericRules

  43. final def notify(): Unit

    Definition Classes
    AnyRef

  44. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  45. implicit def ooo[O](p: Path)(implicit pick: (Path) ⇒ RuleLike[Delimited, String], coerce: RuleLike[String, O]): Rule[Delimited, Option[O]]

    An implicit defining a default Option reader.

    An implicit defining a default Option reader. Uses "" as the empty value.

    O

    The desired type for the value

    p

    An index into the array

    pick

    Function to extract a value from a given index

    coerce

    Coerce the value from String to type O

    returns

    The optional value

  46. def opt[J, O](r: ⇒ RuleLike[J, O], noneValues: RuleLike[Delimited, Delimited]*)(implicit pick: (Path) ⇒ RuleLike[Delimited, Delimited], coerce: RuleLike[Delimited, J]): (Path) ⇒ Rule[Delimited, Option[O]]

    Attributes
    protected
    Definition Classes
    DefaultRules

  47. def optionR[O](noneValues: RuleLike[String, String]*)(implicit pick: (Path) ⇒ RuleLike[Delimited, String], coerce: RuleLike[String, O]): (Path) ⇒ Rule[Delimited, Option[O]]

    Read an optional value using the specified value/rules to determine what is considered None vs what is Some(_).

    Read an optional value using the specified value/rules to determine what is considered None vs what is Some(_).

    O

    The desired type for the value

    noneValues

    Rules for determining if a value should be None

    pick

    Function to extract a value from a given index

    coerce

    Coerce the value from String to type O

    returns

    The optional value

  48. def pattern(regex: Regex): Rule[String, String]

    Definition Classes
    GenericRules

  49. implicit def pick[O](p: Path)(implicit r: RuleLike[String, O]): Rule[Delimited, O]

    Extract the value at a given index, transforming it into a given type.

    Extract the value at a given index, transforming it into a given type.

    O

    The desired type for the value

    p

    An index into the array

    r

    A Rule for converting the value from String to O

    returns

    Failure if the index is out of bounds or the Path was not an IdxPathNode

  50. implicit def seqR[I, O](implicit r: RuleLike[I, O]): Rule[Seq[I], Seq[O]]

    Definition Classes
    GenericRules

  51. implicit def setR[I, O](implicit r: RuleLike[I, O]): Rule[Seq[I], Set[O]]

    Definition Classes
    GenericRules

  52. implicit def shortR: Rule[String, Short]

    Definition Classes
    ParsingRules

  53. implicit val sqlDate: Rule[String, Date]

    Definition Classes
    DateRules

  54. def sqlDateRule(pattern: String, corrector: (String) ⇒ String): Rule[String, Date]

    Definition Classes
    DateRules

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

    Definition Classes
    AnyRef

  56. def toString(): String

    Definition Classes
    AnyRef → Any

  57. implicit def traversableR[I, O](implicit r: RuleLike[I, O]): Rule[Seq[I], Traversable[O]]

    Definition Classes
    GenericRules

  58. def validateWith[I](msg: String, args: Any*)(pred: (I) ⇒ Boolean): Rule[I, I]

    Definition Classes
    GenericRules

  59. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ParsingRules

Inherited from DefaultRules[Delimited]

Inherited from DateRules

Inherited from GenericRules

Inherited from AnyRef

Inherited from Any

Ungrouped