Class

ml.combust.bundle

BundleContext

Related Doc: package bundle

Permalink

case class BundleContext[Context](context: Context, format: SerializationFormat, bundleRegistry: BundleRegistry, fs: FileSystem, path: Path) extends HasBundleRegistry with Product with Serializable

Class for holding serialization information for a ml.combust.bundle.dsl.Bundle.

This class holds all contextual information for serializing components into Bundle.ML.

Context

extra contextual information specific to implementation

format

desired serialization format (Json, Protobuf, or Mixed)

bundleRegistry

bundle registry of all supported operations

fs

file system for bundle

path

path to the Bundle.ML model

Linear Supertypes
Serializable, Serializable, Product, Equals, HasBundleRegistry, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BundleContext
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HasBundleRegistry
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BundleContext(context: Context, format: SerializationFormat, bundleRegistry: BundleRegistry, fs: FileSystem, path: Path)

    Permalink

    format

    desired serialization format (Json, Protobuf, or Mixed)

    bundleRegistry

    bundle registry of all supported operations

    fs

    file system for bundle

    path

    path to the Bundle.ML model

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  5. def bundleContext(file: String): BundleContext[Context]

    Permalink

    Create a new bundle context for a subfolder.

    Create a new bundle context for a subfolder.

    file

    name of subfolder

    returns

    bundle context for the subfolder

  6. val bundleRegistry: BundleRegistry

    Permalink

    bundle registry of all supported operations

    bundle registry of all supported operations

    Definition Classes
    BundleContextHasBundleRegistry
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val context: Context

    Permalink
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def file(name: String): Path

    Permalink

    Get a file in the current bundle folder.

    Get a file in the current bundle folder.

    name

    name of the file

    returns

    file in the bundle

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. val format: SerializationFormat

    Permalink

    desired serialization format (Json, Protobuf, or Mixed)

  13. val fs: FileSystem

    Permalink

    file system for bundle

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  19. val path: Path

    Permalink

    path to the Bundle.ML model

  20. def preferredSerializationContext(preferred: ConcreteSerializationFormat): SerializationContext

    Permalink

    Get a concrete serialization format from a preferrece concrete format.

    Get a concrete serialization format from a preferrece concrete format.

    If the Bundle.ML serialization format is Mixed, this will return the preferred concrete format. Otherwise, it will return the Bundle.ML serialization format.

    This method is used to determine how to serialize certain objects that have a preference for serializing to JSON or Protobuf. For instance, a ml.combust.bundle.dsl.Model prefers to be serialized as JSON. However, if the serialization format for the bundle is Protobuf, then it will be serialized as protobuf.

    preferred

    preferred concrete serialization format

    returns

    actual concrete serialization format for object

  21. def serializationContext(concrete: ConcreteSerializationFormat): SerializationContext

    Permalink

    Create a serialization context.

    Create a serialization context.

    Serialization context objects have a concrete serialization format. This concrete format determines how to serialize Bundle.ML components.

    concrete

    actual serialization format for a Bundle.ML component

    returns

    serialization context with bundle registry and concrete serialization format

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasBundleRegistry

Inherited from AnyRef

Inherited from Any

Ungrouped