Class

scalax.collection.io.json.descriptor

CEdgeDescriptor

Related Doc: package descriptor

Permalink

class CEdgeDescriptor[N, E[X] <: CEdge[X], +C <: CEdgeCompanion[E], P <: Product] extends EdgeDescriptorBase[N, E, C]

Determines how to extract data relevant for custom edges from a JValue and how to decompose such an outer edge to a JValue.

Instances of this class must be passed as a constructor argument to a scalax.collection.io.json.descriptor.Descriptor either directly or indirectly by utilizing a predefined edge descriptor.

Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CEdgeDescriptor
  2. EdgeDescriptorBase
  3. GenEdgeDescriptor
  4. TypeId
  5. AnyRef
  6. Any
Implicitly
  1. by CollectionsHaveToParArray
  2. by EdgeAssoc
  3. by anyToNode
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CEdgeDescriptor(edgeCompanion: C, sampleAttributes: P, customSerializer: Option[Serializer[_ <: CEdgeParameters[P]]] = None, extraClasses: List[Class[_]] = Nil, typeId: String = Defaults.defaultId)(implicit edgeManifest: ClassTag[E[N]], attributeManifest: Manifest[P])

    Permalink

    edgeCompanion

    an edge companion object such as a custom edge companion.

    customSerializer

    Some list-json custom serializer or None.

    extraClasses

    list of classes referenced by this node provided they are to be (de)serialized; empty by default.

    typeId

    denotes the edge type in a JSON text.

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to any2stringadd[CEdgeDescriptor[N, E, C, P]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CEdgeDescriptor[N, E, C, P], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to ArrowAssoc[CEdgeDescriptor[N, E, C, P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. implicit val attributeManifest: Manifest[P]

    Permalink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val customSerializer: Option[Serializer[_ <: Parameters]]

    Permalink
    Definition Classes
    EdgeDescriptorBase
  10. final def decompose(edge: E[N])(implicit descriptor: Descriptor[N]): JValue

    Permalink
    Definition Classes
    EdgeDescriptorBase
  11. val edgeCompanion: C

    Permalink
    Definition Classes
    EdgeDescriptorBase
  12. val edgeManifest: ClassTag[_]

    Permalink
    Definition Classes
    GenEdgeDescriptor
  13. def ensuring(cond: (CEdgeDescriptor[N, E, C, P]) ⇒ Boolean, msg: ⇒ Any): CEdgeDescriptor[N, E, C, P]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to Ensuring[CEdgeDescriptor[N, E, C, P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (CEdgeDescriptor[N, E, C, P]) ⇒ Boolean): CEdgeDescriptor[N, E, C, P]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to Ensuring[CEdgeDescriptor[N, E, C, P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): CEdgeDescriptor[N, E, C, P]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to Ensuring[CEdgeDescriptor[N, E, C, P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): CEdgeDescriptor[N, E, C, P]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to Ensuring[CEdgeDescriptor[N, E, C, P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. val extraClasses: List[Class[_]]

    Permalink
    Definition Classes
    EdgeDescriptorBase
  20. def extract(jsonEdge: JValue): CEdgeParameters[P]

    Permalink
    Definition Classes
    CEdgeDescriptorEdgeDescriptorBase
  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. implicit val formats: Formats

    Permalink
    Definition Classes
    EdgeDescriptorBase
  23. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to StringFormat[CEdgeDescriptor[N, E, C, P]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  26. def isDefined: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to OuterNode[CEdgeDescriptor[N, E, C, P]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    Param
  27. def isEdge: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to OuterNode[CEdgeDescriptor[N, E, C, P]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  28. def isIn: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to OuterNode[CEdgeDescriptor[N, E, C, P]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    InParam → Param
  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def isNode: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to OuterNode[CEdgeDescriptor[N, E, C, P]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  31. def isOut: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to OuterNode[CEdgeDescriptor[N, E, C, P]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    InParam → Param
  32. val n1: CEdgeDescriptor[N, E, C, P]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to EdgeAssoc[CEdgeDescriptor[N, E, C, P]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
  33. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  34. def nodeIds(edge: E[N], descriptor: Descriptor[N]): List[String]

    Permalink
    Attributes
    protected
    Definition Classes
    EdgeDescriptorBase
  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. val sampleAttributes: P

    Permalink
  38. def stringPrefix: String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to OuterNode[CEdgeDescriptor[N, E, C, P]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    NodeParam
  39. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  40. def toParArray: ParArray[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to CollectionsHaveToParArray[CEdgeDescriptor[N, E, C, P], T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (CEdgeDescriptor[N, E, C, P]) ⇒ GenTraversableOnce[T] is in scope.
    Definition Classes
    CollectionsHaveToParArray
  41. def toParameters(edge: E[N])(implicit descriptor: Descriptor[N]): CEdgeParameters[P]

    Permalink
    Attributes
    protected
    Definition Classes
    CEdgeDescriptorEdgeDescriptorBase
  42. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  43. val typeId: String

    Permalink
    Definition Classes
    GenEdgeDescriptorTypeId
  44. val value: CEdgeDescriptor[N, E, C, P]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to OuterNode[CEdgeDescriptor[N, E, C, P]] performed by method anyToNode in scalax.collection.GraphPredef.
    Definition Classes
    OuterNode → NodeParam
  45. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def ~[N >: N1](n2: N): UnDiEdge[N]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to EdgeAssoc[CEdgeDescriptor[N, E, C, P]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  49. def ~>[N >: N1](n2: N): DiEdge[N]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to EdgeAssoc[CEdgeDescriptor[N, E, C, P]] performed by method EdgeAssoc in scalax.collection.GraphPredef.
    Definition Classes
    EdgeAssoc
    Annotations
    @inline()
  50. def [B](y: B): (CEdgeDescriptor[N, E, C, P], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to ArrowAssoc[CEdgeDescriptor[N, E, C, P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def toString(): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CEdgeDescriptor[N, E, C, P] to OuterNode[CEdgeDescriptor[N, E, C, P]] performed by method anyToNode in scalax.collection.GraphPredef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (cEdgeDescriptor: OuterNode[CEdgeDescriptor[N, E, C, P]]).toString()
    Definition Classes
    NodeParam → AnyRef → Any

Inherited from EdgeDescriptorBase[N, E, C]

Inherited from GenEdgeDescriptor[N]

Inherited from TypeId

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion CollectionsHaveToParArray from CEdgeDescriptor[N, E, C, P] to CollectionsHaveToParArray[CEdgeDescriptor[N, E, C, P], T]

Inherited by implicit conversion EdgeAssoc from CEdgeDescriptor[N, E, C, P] to EdgeAssoc[CEdgeDescriptor[N, E, C, P]]

Inherited by implicit conversion anyToNode from CEdgeDescriptor[N, E, C, P] to OuterNode[CEdgeDescriptor[N, E, C, P]]

Inherited by implicit conversion any2stringadd from CEdgeDescriptor[N, E, C, P] to any2stringadd[CEdgeDescriptor[N, E, C, P]]

Inherited by implicit conversion StringFormat from CEdgeDescriptor[N, E, C, P] to StringFormat[CEdgeDescriptor[N, E, C, P]]

Inherited by implicit conversion Ensuring from CEdgeDescriptor[N, E, C, P] to Ensuring[CEdgeDescriptor[N, E, C, P]]

Inherited by implicit conversion ArrowAssoc from CEdgeDescriptor[N, E, C, P] to ArrowAssoc[CEdgeDescriptor[N, E, C, P]]

Ungrouped