rogue

Type Members

class ArrayField[V, O] extends MCField[Array[V], O]
trait BaseBsonFormats extends AnyRef

Basic bson serializers
trait BasicBsonFormat[T] extends BsonFormat[T] with BsonArrayReader[T]
class BigDecimalField[O] extends MCField[BigDecimal, O]
class BigDecimalModifyField[M] extends AbstractModifyField[BigDecimal, BsonDecimal128, M]
class BigDecimalQueryField[M] extends AbstractQueryField[BigDecimal, BigDecimal, BsonDecimal128, M]
class BooleanField[O] extends MCField[Boolean, O]
trait BsonArrayReader[T] extends AnyRef
trait BsonCollectionFormats extends AnyRef
trait BsonFormat[T] extends AnyRef

Annotations
@implicitNotFound( ... )
trait BsonFormats extends LowPrioBsonFormats
abstract class CClassAbstractRequiredField[C, MC <: CcMeta[C], O] extends CClassField[C, MC, O] with RequiredField[C, O]

Same as CClassField but because defaultValue is required, it can be selected.
Same as CClassField but because defaultValue is required, it can be selected. If you don't want to provide defaultValue use CClassField but you will not be able to select that cc. To create a field like that you must overrife defaultValue, or just use CClassRequiredField.
class CClassArrayField[C, MC <: CcMeta[C], O] extends MCField[Array[C], O] with HasChildMeta[C, MC]
class CClassArrayModifyField[C, M <: CcMeta[C], O] extends AbstractArrayModifyField[C, BsonDocument, O]
class CClassArrayQueryField[C, M <: CcMeta[C], O] extends AbstractArrayQueryField[C, C, BsonValue, O, C]
class CClassField[C, MC <: CcMeta[C], O] extends Field[C, O]
class CClassLikeQueryField[C, M <: CcMeta[C], O] extends AbstractQueryField[C, C, BsonValue, O]
class CClassListField[C, MC <: CcMeta[C], O] extends MCField[Seq[C], O] with HasChildMeta[C, MC]
class CClassModifyField[C, M <: CcMeta[C], O] extends AbstractModifyField[C, BsonDocument, O]
class CClassQueryField[C, M <: CcMeta[C], O] extends AbstractQueryField[C, C, BsonValue, O]
class CClassRequiredField[C, MC <: CcMeta[C], O] extends CClassAbstractRequiredField[C, MC, O]

Same as CClassField but because defaultValue is required, it can be selected.
Same as CClassField but because defaultValue is required, it can be selected. If you don't want to provide defaultValue use CClassField but you will not be able to select that cc.
class CClassSeqModifyField[C, M <: CcMeta[C], O] extends AbstractListModifyField[C, BsonDocument, O, Seq]
class CClassSeqQueryField[C, M <: CcMeta[C], O] extends AbstractListQueryField[C, C, BsonValue, O, Seq]

Trait representing a field and all the operations on it.
Trait representing a field and all the operations on it.
M
the type of the owner of the field
abstract class CField[V, O] extends Field[V, O]
trait CcFields[T] extends AnyRef
class CurrencyField[O] extends MCField[Currency, O]
class CurrencyModifyField[M] extends AbstractModifyField[Currency, BsonString, M]
class CurrencyQueryField[M] extends AbstractQueryField[Currency, Currency, BsonString, M]
class DoubleField[O] extends MCField[Double, O]
class EnumField[T <: Enumeration, O] extends MCField[rogue.EnumField.T.Value, O] with ReflectEnumInstance[T]
class EnumIdField[T <: Enumeration, O] extends MCField[rogue.EnumIdField.T.Value, O] with ReflectEnumInstance[T]
class EnumIdModifyField[M, E <: Value] extends AbstractModifyField[E, Int, M]
trait EnumNameFormats extends AnyRef

serialize enums as names
class EnumSerializeValue extends Annotation with StaticAnnotation
trait EnumValueFormats extends AnyRef

serialize enums as integers
trait HasChildMeta[C, MC <: CcMeta[C]] extends AnyRef
type InitialState = Unordered with Unselected with Unlimited with Unskipped with HasNoOrClause with Unhinted with ShardKeyNotSpecified
class InstantField[O] extends MCField[Instant, O]
class InstantModifyField[O] extends AbstractModifyField[Instant, Date, O]
class InstantQueryField[M] extends AbstractQueryField[Instant, Instant, Date, M]
class IntField[O] extends MCField[Int, O]
class IntTaggedField[Tag, O] extends MCField[@@[Int, Tag], O]
class ListField[V, O] extends MCField[List[V], O]
class LocalDateTimeField[O] extends MCField[LocalDateTime, O]
class LocalDateTimeModifyField[O] extends AbstractModifyField[LocalDateTime, Date, O]
class LocalDateTimeQueryField[M] extends AbstractQueryField[LocalDateTime, LocalDateTime, Date, M]
class LongField[O] extends MCField[Long, O]
class LongTaggedField[Tag, O] extends MCField[@@[Long, Tag], O]
trait LowPrioBsonFormats extends AnyRef
trait LowPrioFields extends AnyRef
abstract class MCField[V, O] extends CField[V, O] with RequiredField[V, O]
class MapField[K, V, O] extends MCField[Map[K, V], O]
class NoDefaultFormatForDerivedException extends RuntimeException
abstract class OCField[V, O] extends CField[V, O] with OptionalField[V, O]
class ObjectIdField[O] extends MCField[ObjectId, O]
class ObjectIdSubtypeField[Subtype <: ObjectId, O] extends MCField[Subtype, O]
class ObjectIdTaggedField[Tag, O] extends MCField[@@[ObjectId, Tag], O]
class OptArrayField[V, O] extends OCField[Array[V], O]
class OptBigDecimalField[O] extends OCField[BigDecimal, O]
class OptBooleanField[O] extends OCField[Boolean, O]
class OptCClassArrayField[C, MC <: CcMeta[C], O] extends OCField[Array[C], O] with HasChildMeta[C, MC]
class OptCClassField[C, MC <: CcMeta[C], O] extends OCField[C, O] with HasChildMeta[C, MC]
class OptCClassListField[C, MC <: CcMeta[C], O] extends OCField[Seq[C], O] with HasChildMeta[C, MC]
class OptCClassModifyField[C, M <: CcMeta[C], O] extends AbstractModifyField[C, BsonDocument, O]
class OptCClassQueryField[C, M <: CcMeta[C], O] extends AbstractQueryField[C, C, BsonValue, O]
class OptCurrencyField[O] extends OCField[Currency, O]
class OptDoubleField[O] extends OCField[Double, O]
class OptEnumField[T <: Enumeration, O] extends OCField[rogue.OptEnumField.T.Value, O]
class OptEnumIdField[T <: Enumeration, O] extends OCField[rogue.OptEnumIdField.T.Value, O]
class OptInstantField[O] extends OCField[Instant, O]
class OptIntField[O] extends OCField[Int, O]
class OptIntTaggedField[Tag, O] extends OCField[@@[Int, Tag], O]
class OptListField[V, O] extends OCField[List[V], O]
class OptLocalDateTimeField[O] extends OCField[LocalDateTime, O]
class OptLongField[O] extends OCField[Long, O]
class OptLongTaggedField[Tag, O] extends OCField[@@[Long, Tag], O]
class OptMapField[V, O] extends OCField[Map[String, V], O]
class OptObjectIdField[O] extends OCField[ObjectId, O]
class OptObjectIdSubtypeField[Subtype <: ObjectId, O] extends OCField[Subtype, O]
class OptObjectIdTaggedField[Tag, O] extends OCField[@@[ObjectId, Tag], O]
class OptStringField[O] extends OCField[String, O]
class OptStringTaggedField[Tag, O] extends OCField[@@[String, Tag], O]
class OptUUIDIdField[O] extends OCField[UUID, O]
class OptUUIDIdTaggedField[Tag, O] extends OCField[@@[UUID, Tag], O]
type OrderedQuery[M] = Query[M, M, OrderedState]
type OrderedState = Ordered with Unselected with Unlimited with Unskipped with HasNoOrClause with ShardKeyNotSpecified
class SelectableDummyCCField[V, M <: CcMeta[V], O] extends SelectableDummyField[V, O]
type SimpleQuery[M] = Query[M, M, InitialState]
trait StandardBsonFormats extends BaseBsonFormats with BsonCollectionFormats with MapKeyFormats
class StringField[O] extends MCField[String, O]
class StringTaggedField[Tag, O] extends MCField[@@[String, Tag], O]
class UUIDIdField[O] extends MCField[UUID, O]
class UUIDIdTaggedField[Tag, O] extends MCField[@@[UUID, Tag], O]

Value Members

object BsonFormat
object BsonFormats extends StandardBsonFormats with BsonFormats
object CcFields extends LowPrioFields

object EnumAnnotatedFormats

Sometimes it is necessary to use Enumerations that are serialized to Ints and others that serialize to Strings within the same tech.scoundrel.rogue.cc.RCcMeta.

Sometimes it is necessary to use Enumerations that are serialized to Ints and others that serialize to Strings within the same tech.scoundrel.rogue.cc.RCcMeta. It can be obtained by using EnumSerializeValue annotation

See also

EnumAnnotationTest example:

object EName extends Enumeration { val v1 = Value("V1"); val v2 = Value("V2") }
@EnumSerializeValue object EValue extends Enumeration { val v1 = Value("bla1"); val v2 = Value("bla2") }
case class C(e:EName.Value, v: EValue.Value)
import import BsonFormats._ ;import EnumAnnotatedFormats._
implicit val enE = EName
implicit val evE = EValue
val format = BsonFormat[C]
println(format.write(C(EName.v1, EValue.v2)))

will produce

{ "v" : 1, "e" : "V1" }

object EnumNameFormats extends EnumNameFormats
object EnumValueFormats extends EnumValueFormats
object LocalDateTimeToMongo
package cc
package enums
package map
package naming

package rogue

Type Members

class ArrayField[V, O] extends MCField[Array[V], O]

trait BaseBsonFormats extends AnyRef

trait BasicBsonFormat[T] extends BsonFormat[T] with BsonArrayReader[T]

class BigDecimalField[O] extends MCField[BigDecimal, O]

class BigDecimalModifyField[M] extends AbstractModifyField[BigDecimal, BsonDecimal128, M]

class BigDecimalQueryField[M] extends AbstractQueryField[BigDecimal, BigDecimal, BsonDecimal128, M]

class BooleanField[O] extends MCField[Boolean, O]

trait BsonArrayReader[T] extends AnyRef

trait BsonCollectionFormats extends AnyRef

trait BsonFormat[T] extends AnyRef

trait BsonFormats extends LowPrioBsonFormats

abstract class CClassAbstractRequiredField[C, MC <: CcMeta[C], O] extends CClassField[C, MC, O] with RequiredField[C, O]

class CClassArrayField[C, MC <: CcMeta[C], O] extends MCField[Array[C], O] with HasChildMeta[C, MC]

class CClassArrayModifyField[C, M <: CcMeta[C], O] extends AbstractArrayModifyField[C, BsonDocument, O]

class CClassArrayQueryField[C, M <: CcMeta[C], O] extends AbstractArrayQueryField[C, C, BsonValue, O, C]

class CClassField[C, MC <: CcMeta[C], O] extends Field[C, O]

class CClassLikeQueryField[C, M <: CcMeta[C], O] extends AbstractQueryField[C, C, BsonValue, O]

class CClassListField[C, MC <: CcMeta[C], O] extends MCField[Seq[C], O] with HasChildMeta[C, MC]

class CClassModifyField[C, M <: CcMeta[C], O] extends AbstractModifyField[C, BsonDocument, O]

class CClassQueryField[C, M <: CcMeta[C], O] extends AbstractQueryField[C, C, BsonValue, O]

class CClassRequiredField[C, MC <: CcMeta[C], O] extends CClassAbstractRequiredField[C, MC, O]

class CClassSeqModifyField[C, M <: CcMeta[C], O] extends AbstractListModifyField[C, BsonDocument, O, Seq]

class CClassSeqQueryField[C, M <: CcMeta[C], O] extends AbstractListQueryField[C, C, BsonValue, O, Seq]

abstract class CField[V, O] extends Field[V, O]

trait CcFields[T] extends AnyRef

class CurrencyField[O] extends MCField[Currency, O]

class CurrencyModifyField[M] extends AbstractModifyField[Currency, BsonString, M]

class CurrencyQueryField[M] extends AbstractQueryField[Currency, Currency, BsonString, M]

class DoubleField[O] extends MCField[Double, O]

class EnumField[T <: Enumeration, O] extends MCField[rogue.EnumField.T.Value, O] with ReflectEnumInstance[T]

class EnumIdField[T <: Enumeration, O] extends MCField[rogue.EnumIdField.T.Value, O] with ReflectEnumInstance[T]

class EnumIdModifyField[M, E <: Value] extends AbstractModifyField[E, Int, M]

trait EnumNameFormats extends AnyRef

class EnumSerializeValue extends Annotation with StaticAnnotation

trait EnumValueFormats extends AnyRef

trait HasChildMeta[C, MC <: CcMeta[C]] extends AnyRef

type InitialState = Unordered with Unselected with Unlimited with Unskipped with HasNoOrClause with Unhinted with ShardKeyNotSpecified

class InstantField[O] extends MCField[Instant, O]

class InstantModifyField[O] extends AbstractModifyField[Instant, Date, O]

class InstantQueryField[M] extends AbstractQueryField[Instant, Instant, Date, M]

class IntField[O] extends MCField[Int, O]

class IntTaggedField[Tag, O] extends MCField[@@[Int, Tag], O]

class ListField[V, O] extends MCField[List[V], O]

class LocalDateTimeField[O] extends MCField[LocalDateTime, O]

class LocalDateTimeModifyField[O] extends AbstractModifyField[LocalDateTime, Date, O]

class LocalDateTimeQueryField[M] extends AbstractQueryField[LocalDateTime, LocalDateTime, Date, M]

class LongField[O] extends MCField[Long, O]

class LongTaggedField[Tag, O] extends MCField[@@[Long, Tag], O]

trait LowPrioBsonFormats extends AnyRef

trait LowPrioFields extends AnyRef

abstract class MCField[V, O] extends CField[V, O] with RequiredField[V, O]

class MapField[K, V, O] extends MCField[Map[K, V], O]

class NoDefaultFormatForDerivedException extends RuntimeException

abstract class OCField[V, O] extends CField[V, O] with OptionalField[V, O]

class ObjectIdField[O] extends MCField[ObjectId, O]

class ObjectIdSubtypeField[Subtype <: ObjectId, O] extends MCField[Subtype, O]

class ObjectIdTaggedField[Tag, O] extends MCField[@@[ObjectId, Tag], O]

class OptArrayField[V, O] extends OCField[Array[V], O]

class OptBigDecimalField[O] extends OCField[BigDecimal, O]

class OptBooleanField[O] extends OCField[Boolean, O]

class OptCClassArrayField[C, MC <: CcMeta[C], O] extends OCField[Array[C], O] with HasChildMeta[C, MC]

class OptCClassField[C, MC <: CcMeta[C], O] extends OCField[C, O] with HasChildMeta[C, MC]

class OptCClassListField[C, MC <: CcMeta[C], O] extends OCField[Seq[C], O] with HasChildMeta[C, MC]

class OptCClassModifyField[C, M <: CcMeta[C], O] extends AbstractModifyField[C, BsonDocument, O]

class OptCClassQueryField[C, M <: CcMeta[C], O] extends AbstractQueryField[C, C, BsonValue, O]

class OptCurrencyField[O] extends OCField[Currency, O]

class OptDoubleField[O] extends OCField[Double, O]

class OptEnumField[T <: Enumeration, O] extends OCField[rogue.OptEnumField.T.Value, O]

class OptEnumIdField[T <: Enumeration, O] extends OCField[rogue.OptEnumIdField.T.Value, O]

class OptInstantField[O] extends OCField[Instant, O]

class OptIntField[O] extends OCField[Int, O]

class OptIntTaggedField[Tag, O] extends OCField[@@[Int, Tag], O]

class OptListField[V, O] extends OCField[List[V], O]

class OptLocalDateTimeField[O] extends OCField[LocalDateTime, O]

class OptLongField[O] extends OCField[Long, O]

class OptLongTaggedField[Tag, O] extends OCField[@@[Long, Tag], O]

class OptMapField[V, O] extends OCField[Map[String, V], O]