Package

scalax.collection.io.json

descriptor

Permalink

package descriptor

These classes serve as meta-data controlling JSON import by fromJson and export by toJson. Among all, the meta-data contain identifiers based on which JSON edges will be matched to edge classes and Graph-specific serializers to be involved.

Linear Supertypes
Content Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. descriptor
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

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

    Permalink

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

    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.

  2. class CHyperEdgeDescriptor[N, E[X] <: CHyperEdge[X], +C <: CHyperEdgeCompanion[E], P <: Product] extends EdgeDescriptorBase[N, E, C]

    Permalink

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

    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.

  3. class Descriptor[N] extends AnyRef

    Permalink

    Top level descriptor to be passed to Graph/JSON conversion methods, in particular to fromJson and toJson.

  4. class EdgeDescriptor[N, E[X] <: UnDiEdge[X], +C <: EdgeCompanion[E]] extends EdgeDescriptorBase[N, E, C]

    Permalink

    Determines how to extract data relevant for non-weighted, non-labeled edges from a JValue and how to decompose such an outer edge to a JValue.

    Determines how to extract data relevant for non-weighted, non-labeled 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.

  5. sealed abstract class EdgeDescriptorBase[N, E[X] <: EdgeLikeIn[X], +C <: EdgeCompanionBase[E]] extends GenEdgeDescriptor[N]

    Permalink

    Base trait for any class *EdgeDescriptor.

  6. sealed abstract class GenEdgeDescriptor[N] extends TypeId

    Permalink

    Generic base trait for any *EdgeDescriptor excluding edge types to be used as type argument to collections containing edge descriptors of different types.

  7. class HyperEdgeDescriptor[N, E[X] <: HyperEdge[X], +C <: HyperEdgeCompanion[E]] extends EdgeDescriptorBase[N, E, C]

    Permalink

    Determines how to extract data relevant for non-weighted, non-labeled hyperedges from a JValue and how to decompose such an outer edge to a JValue.

    Determines how to extract data relevant for non-weighted, non-labeled hyperedges 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.

  8. class LEdgeDescriptor[N, E[X] <: UnDiEdge[X] with LEdge[X], +C <: LEdgeCompanion[E], L <: AnyRef] extends EdgeDescriptorBase[N, E, C]

    Permalink

    Determines how to extract data relevant for non-weighted, labeled edges from a JValue and how to decompose such an outer edge to a JValue.

    Determines how to extract data relevant for non-weighted, labeled 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.

  9. class LHyperEdgeDescriptor[N, E[X] <: LHyperEdge[X], +C <: LHyperEdgeCompanion[E], L <: AnyRef] extends EdgeDescriptorBase[N, E, C]

    Permalink

    Determines how to extract data relevant for non-weighted, labeled hyperedges from a JValue and how to decompose such an outer edge to a JValue.

    Determines how to extract data relevant for non-weighted, labeled hyperedges 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.

  10. abstract class NodeDescriptor[+N] extends TypeId

    Permalink

    Provides information on how to extract node data from a JValue and how to decompose the node to a JValue.

    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.

  11. class SectionId extends (String, String)

    Permalink

    Contains string constants to denote node/edge sections in a JSON text.

    Contains string constants to denote node/edge sections in a JSON text.

    An individual instance of this class may be passed to Descriptor if non-default section id's are to be used.

  12. abstract class TypeId extends AnyRef

    Permalink
  13. class WEdgeDescriptor[N, E[X] <: UnDiEdge[X] with WEdge[X], +C <: WEdgeCompanion[E]] extends EdgeDescriptorBase[N, E, C]

    Permalink

    Determines how to extract data relevant for weighted, non-labeled edges from a JValue and how to decompose such an outer edge to a JValue.

    Determines how to extract data relevant for weighted, non-labeled 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.

  14. class WHyperEdgeDescriptor[N, E[X] <: WHyperEdge[X], +C <: WHyperEdgeCompanion[E]] extends EdgeDescriptorBase[N, E, C]

    Permalink

    Determines how to extract data relevant for weighted, non-labeled hyperedges from a JValue and how to decompose such an outer edge to a JValue.

    Determines how to extract data relevant for weighted, non-labeled hyperedges 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.

  15. class WLEdgeDescriptor[N, E[X] <: UnDiEdge[X] with WLEdge[X], +C <: WLEdgeCompanion[E], L <: AnyRef] extends EdgeDescriptorBase[N, E, C]

    Permalink

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

    Determines how to extract data relevant for weighted, labeled 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.

  16. class WLHyperEdgeDescriptor[N, E[X] <: WLHyperEdge[X], +C <: WLHyperEdgeCompanion[E], L <: AnyRef] extends EdgeDescriptorBase[N, E, C]

    Permalink

    Determines how to extract data relevant for weighted, labeled hyperedges from a JValue and how to decompose such an outer edge to a JValue.

    Determines how to extract data relevant for weighted, labeled hyperedges 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.

Value Members

  1. object DefaultSectionId extends SectionId

    Permalink

    The default section id's "nodes" and "edges".

  2. object Defaults

    Permalink
  3. object StringNodeDescriptor extends NodeDescriptor[String]

    Permalink

    Node descriptor extracting a String from any JValue and decomposing nodes of any type to a JString.

    Node descriptor extracting a String from any JValue and decomposing nodes of any type to a JString. This object serves mainly test purposes.

  4. package predefined

    Permalink

    This package contains predefined edge descriptors for all basic/predefined edge types.

    This package contains predefined edge descriptors for all basic/predefined edge types. They may be used when defining json.descriptor.Descriptors for convenience. For instance,

    UnDi.descriptor[String](Some(new EdgeSerializer))

    is a shorthand for

    new EdgeDescriptor[String,UnDiEdge,UnDiEdge.type](UnDiEdge, Some(new EdgeSerializer))

    where predefined edge types named <edgeType>Edge map to predefined descriptors named <edgeType>.

Inherited from AnyRef

Inherited from Any

Ungrouped