Packages

  • package root
    Definition Classes
    root
  • package scalax
    Definition Classes
    root
  • package collection
    Definition Classes
    scalax
  • package io
    Definition Classes
    collection
  • package json

    Facilitates populating graphs with nodes/edges from JSON text and exporting Graphinstances to JSON text.

    Facilitates populating graphs with nodes/edges from JSON text and exporting Graphinstances to JSON text.

    See also the Graph for Scala JSON User Guide.

    Definition Classes
    io
  • package descriptor

    These classes serve as meta-data controlling JSON import by fromJson and export by toJson.

    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.

    Definition Classes
    json
  • package predefined

    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>.

  • CEdgeDescriptor
  • CHyperEdgeDescriptor
  • DefaultSectionId
  • Defaults
  • Descriptor
  • EdgeDescriptor
  • EdgeDescriptorBase
  • GenEdgeDescriptor
  • HyperEdgeDescriptor
  • LEdgeDescriptor
  • LHyperEdgeDescriptor
  • NodeDescriptor
  • SectionId
  • StringNodeDescriptor
  • TypeId
  • WEdgeDescriptor
  • WHyperEdgeDescriptor
  • WLEdgeDescriptor
  • WLHyperEdgeDescriptor
  • package error

    Error/warning constants and message producing.

    Error/warning constants and message producing.

    Definition Classes
    json
  • package exp

    Export of graphs to JSON text.

    Export of graphs to JSON text.

    Definition Classes
    json
  • package imp

    Import of JSON text into graphs including the steps

    Import of JSON text into graphs including the steps

    1. parsing (extracting and checking all data from JSON texts relevant to Graph) and
    2. InputStream creation on the basis of parsing results in preparation of calling Graph.fromStream.
    Definition Classes
    json
  • package serializer

    Lift-JSON Serializers converting from/to unnamed JSON values and edge data containers (parameters) covering all predefined edge types.

    Lift-JSON Serializers converting from/to unnamed JSON values and edge data containers (parameters) covering all predefined edge types. They allow to save space as default Lift-JSON serializers would require the JSON text to contain JFields for every node and edge.

    Definition Classes
    json

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
AnyRef, Any
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]

    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]

    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

    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]

    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]

    Base trait for any class *EdgeDescriptor.

  6. sealed abstract class GenEdgeDescriptor[N] extends TypeId

    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]

    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]

    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]

    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

    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 AnyRef

    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
  13. class WEdgeDescriptor[N, E[+X] <: UnDiEdge[X] with WEdge[X], +C <: WEdgeCompanion[E]] extends EdgeDescriptorBase[N, E, C]

    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]

    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]

    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]

    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

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

  2. object Defaults
  3. object StringNodeDescriptor extends NodeDescriptor[String]

    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.

Inherited from AnyRef

Inherited from Any

Ungrouped