abstract class NodeDescriptor[+N] extends TypeId
Provides information on how to extract node data from a JValue and how to decompose the node to a JValue.
- N
type of nodes described with this descriptor which either the same type or a subtype of the node type parameter of the targeted graph.
- Alphabetic
- By Inheritance
- NodeDescriptor
- TypeId
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
NodeDescriptor(typeId: String = Defaults.defaultId, customSerializers: Traversable[Serializer[_]] = Nil, extraClasses: List[Class[_]] = Nil, furtherManifests: List[Manifest[_]] = Nil)(implicit nodeManifest: Manifest[N])
- typeId
denotes the node type in a JSON text; defaults to
(default)
.- customSerializers
list of list-json custom serializers to be invoked for node serialization, defaulting to an empty list.
- extraClasses
list of classes referenced by this node provided they are to be (de)serialized; empty by default.
- furtherManifests
list of manifests denoting subtypes of
N
which are to be processed, defaulting to an empty list.
Abstract Value Members
-
abstract
def
id(node: Any): String
Enables Graph for Scala JSON export/import to handle node references in JSON edge entries.
Enables Graph for Scala JSON export/import to handle node references in JSON edge entries. Without establishing such references, JSON edge entries would have to contain all node data what would make JSON texts representing graphs explode in length.
Please exercise great care when designing the id method to return unique keys.
- node
a node of type
N
for which its unique id is to be returned. You can safely matchnode
to the actual type argumentN
.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from NodeDescriptor[N] to any2stringadd[NodeDescriptor[N]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (NodeDescriptor[N], B)
- Implicit
- This member is added by an implicit conversion from NodeDescriptor[N] to ArrowAssoc[NodeDescriptor[N]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def decompose(node: Any): JValue
-
def
ensuring(cond: (NodeDescriptor[N]) ⇒ Boolean, msg: ⇒ Any): NodeDescriptor[N]
- Implicit
- This member is added by an implicit conversion from NodeDescriptor[N] to Ensuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (NodeDescriptor[N]) ⇒ Boolean): NodeDescriptor[N]
- Implicit
- This member is added by an implicit conversion from NodeDescriptor[N] to Ensuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): NodeDescriptor[N]
- Implicit
- This member is added by an implicit conversion from NodeDescriptor[N] to Ensuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): NodeDescriptor[N]
- Implicit
- This member is added by an implicit conversion from NodeDescriptor[N] to Ensuring[NodeDescriptor[N]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def extract(jsonNode: JValue): N
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- implicit val formats: Formats
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from NodeDescriptor[N] to StringFormat[NodeDescriptor[N]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val manifests: List[Manifest[_]]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
typeId: String
- Definition Classes
- NodeDescriptor → TypeId
-
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
→[B](y: B): (NodeDescriptor[N], B)
- Implicit
- This member is added by an implicit conversion from NodeDescriptor[N] to ArrowAssoc[NodeDescriptor[N]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc