ModelFactory

Abstract Value Members

abstract def fromString(s: String): Try[Model[A, B]]

Read from a String.
Read from a String.
s
a String to read.
returns
the result

Definition Classes
NonFileReadable

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
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( ... )
final def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

Issue a debug logging message, with an exception.
Issue a debug logging message, with an exception.
msg
the message object. toString() is called to convert it to a loggable string.
t
the exception to include with the logged message.

Attributes
protected[this]
Definition Classes
Logging
final def debug(msg: ⇒ Any): Unit

Issue a debug logging message.
Issue a debug logging message.
msg
the message object. toString() is called to convert it to a loggable string.

Attributes
protected[this]
Definition Classes
Logging
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

Issue a error logging message, with an exception.
Issue a error logging message, with an exception.
msg
the message object. toString() is called to convert it to a loggable string.
t
the exception to include with the logged message.

Attributes
protected[this]
Definition Classes
Logging
final def error(msg: ⇒ Any): Unit

Issue a error logging message.
Issue a error logging message.
msg
the message object. toString() is called to convert it to a loggable string.

Attributes
protected[this]
Definition Classes
Logging
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fromClasspathResource(r: String): Try[Model[A, B]]

Read from a classpath resource.
Read from a classpath resource. This uses fromVfs2 under the hood.
r
a classpath resource path.

Definition Classes
FileReadableByInputStream → FileReadable
def fromFile(f: File): Try[Model[A, B]]

Read from a file.
Read from a file. Logs the file.
f
a file to read. The file's InputStream is automatically closed.
returns
the result

Definition Classes
LocationLoggingReadable → FileReadableByInputStream → FileReadable
final def fromInputStream(is: InputStream): Try[Model[A, B]]

Read from an InputStream.
Read from an InputStream.
is
an InputStream to read. The InputStream is automatically closed.
returns
the result

Definition Classes
ReadableByString → FileReadableByInputStream → NonFileReadable
def fromMultipleSources[F[_]](readableTypes: F[ReadableSource])(implicit f: Functor[F]): F[Try[Model[A, B]]]

Parse a bunch of readable sources given a Functor (see Functors, Monads, Applicatives – can be so simple).
Parse a bunch of readable sources given a Functor (see Functors, Monads, Applicatives – can be so simple).
F
the functor type
readableTypes
a container of instances to convert into type the output type
f
a function instance
returns
a container F of the output type B

Definition Classes
MultipleReadable
def fromMultipleSources(readableTypes: Collection[ReadableSource]): Collection[Try[Model[A, B]]]

Parse a bunch of readable sources from a java collection and return the results.
Parse a bunch of readable sources from a java collection and return the results.
readableTypes
a collection of sources from which

Definition Classes
MultipleReadable
def fromMultipleSources(readableTypes: List[ReadableSource]): List[Try[Model[A, B]]]

Parse a list of readable sources and return the results.
Parse a list of readable sources and return the results.
readableTypes
a list of readable sources containing the necessary information to parse the resource and produce the proper outputs.
returns
a list of objects produced by parsing the resources in the readable types.

Definition Classes
MultipleReadable
final def fromReader(r: Reader): Try[Model[A, B]]

Read from a Reader.
Read from a Reader. Whoever extends this trait is responsible for closing the Reader.
r
a Reader containing data to be read.
returns
the result

Definition Classes
ReadableByString → NonFileReadable
def fromResource(r: String): Try[Model[A, B]]

Read from a resource.
Read from a resource. This uses fromVfs2 under the hood.
r
a resource path.

Definition Classes
FileReadableByInputStream → FileReadable
def fromSequencedMultipleSources[T[_]](readableTypes: T[ReadableSource])(implicit t: Traverse[T], ap: Applicative[Try]): Try[T[Model[A, B]]]

Produce multiple outputs from multiple inputs and sequence the data so that we commute that container types.
Produce multiple outputs from multiple inputs and sequence the data so that we commute that container types. For an example, see that trait documentation.
T
the Traverse container type
readableTypes
A container of readable sources to convert to outputs.
t
a Traverse type class instance
ap
an applicative function type class instance

Definition Classes
SequenceMultipleReadable
def fromUrl(u: URL): Try[Model[A, B]]

Read from a URL.
Read from a URL. Logs the URL.
u
a URL to read. The URL's InputStream is automatically closed.
returns
the result

Definition Classes
LocationLoggingReadable → FileReadableByInputStream → FileReadable
def fromVfs1(foVfs1: FileObject): Try[Model[A, B]]

Read from an Apache VFS v1 FileObject.
Read from an Apache VFS v1 FileObject. Logs the file object location.
foVfs1
an Apache VFS v1 FileObject to read. The FileObject's InputStream is automatically closed.
returns
the result

Definition Classes
LocationLoggingReadable → FileReadableByInputStream → FileReadable
def fromVfs2(foVfs2: FileObject): Try[Model[A, B]]

Read from an Apache VFS v1 FileObject.
Read from an Apache VFS v1 FileObject. Logs the file object location.
foVfs2
an Apache VFS v1 FileObject to read. The FileObject's InputStream is automatically closed.
returns
the result

Definition Classes
LocationLoggingReadable → FileReadableByInputStream → FileReadable
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def gz: FileReadableByInputStream[Try[Model[A, B]]] with MultipleFileReadable[Try[Model[A, B]]]

Definition Classes
GZippedReadable
def hashCode(): Int

Definition Classes
AnyRef → Any
final def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

Issue a info logging message, with an exception.
Issue a info logging message, with an exception.
msg
the message object. toString() is called to convert it to a loggable string.
t
the exception to include with the logged message.

Attributes
protected[this]
Definition Classes
Logging
final def info(msg: ⇒ Any): Unit

Issue a info logging message.
Issue a info logging message.
msg
the message object. toString() is called to convert it to a loggable string.

Attributes
protected[this]
Definition Classes
Logging
val inputCharset: String

The character set that is used to decode the input streams in fromInputStream in the derived classes.
The character set that is used to decode the input streams in fromInputStream in the derived classes.

Attributes
protected
Definition Classes
ReadableByString
final def isDebugEnabled: Boolean

Determine whether debug logging is enabled.
Determine whether debug logging is enabled.

Attributes
protected[this]
Definition Classes
Logging
final def isErrorEnabled: Boolean

Determine whether error logging is enabled.
Determine whether error logging is enabled.

Attributes
protected[this]
Definition Classes
Logging
final def isInfoEnabled: Boolean

Determine whether info logging is enabled.
Determine whether info logging is enabled.

Attributes
protected[this]
Definition Classes
Logging
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isTraceEnabled: Boolean

Determine whether trace logging is enabled.
Determine whether trace logging is enabled.

Attributes
protected[this]
Definition Classes
Logging
final def isWarnEnabled: Boolean

Determine whether warn logging is enabled.
Determine whether warn logging is enabled.

Attributes
protected[this]
Definition Classes
Logging
final lazy val logger: Logger

The logger is a @transient lazy val to enable proper working with Spark.
The logger is a @transient lazy val to enable proper working with Spark. The logger will not be serialized with the rest of the class with which this trait is mixed-in.

Attributes
protected[this]
Definition Classes
Logging
def loggerInitName(): String

The name with which the logger is initialized.
The name with which the logger is initialized. This can be overridden in a derived class.

Attributes
protected
Definition Classes
Logging
final def loggerName: String

Get the name associated with this logger.
Get the name associated with this logger.
returns
the name.

Attributes
protected[this]
Definition Classes
Logging
val mapper: (ReadableSource) ⇒ Try[Model[A, B]]

A function that maps from the Readable type to the output type.
A function that maps from the Readable type to the output type.
returns
a function.

Definition Classes
MultipleAlohaReadable → MultipleReadable
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
final def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

Issue a trace logging message, with an exception.
Issue a trace logging message, with an exception.
msg
the message object. toString() is called to convert it to a loggable string.
t
the exception to include with the logged message.

Attributes
protected[this]
Definition Classes
Logging
final def trace(msg: ⇒ Any): Unit

Issue a trace logging message.
Issue a trace logging message.
msg
the message object. toString() is called to convert it to a loggable string.

Attributes
protected[this]
Definition Classes
Logging
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( ... )
final def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

Issue a warn logging message, with an exception.
Issue a warn logging message, with an exception.
msg
the message object. toString() is called to convert it to a loggable string.
t
the exception to include with the logged message.

Attributes
protected[this]
Definition Classes
Logging
final def warn(msg: ⇒ Any): Unit

Issue a warn logging message.
Issue a warn logging message.
msg
the message object. toString() is called to convert it to a loggable string.

Attributes
protected[this]
Definition Classes
Logging

Related Docs: object ModelFactory | package factory

sealed abstract class ModelFactory[A, B] extends ReadableByString[Try[Model[A, B]]] with GZippedReadable[Try[Model[A, B]]] with LocationLoggingReadable[Try[Model[A, B]]] with MultipleAlohaReadable[Try[Model[A, B]]] with SequenceMultipleReadable[ReadableSource, Try, Model[A, B]] with Logging

Abstract Value Members

abstract def fromString(s: String): Try[Model[A, B]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

final def debug(msg: ⇒ Any): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

final def error(msg: ⇒ Any): Unit

def finalize(): Unit

def fromClasspathResource(r: String): Try[Model[A, B]]

def fromFile(f: File): Try[Model[A, B]]

final def fromInputStream(is: InputStream): Try[Model[A, B]]

def fromMultipleSources[F[_]](readableTypes: F[ReadableSource])(implicit f: Functor[F]): F[Try[Model[A, B]]]

def fromMultipleSources(readableTypes: Collection[ReadableSource]): Collection[Try[Model[A, B]]]

def fromMultipleSources(readableTypes: List[ReadableSource]): List[Try[Model[A, B]]]

final def fromReader(r: Reader): Try[Model[A, B]]

def fromResource(r: String): Try[Model[A, B]]

def fromSequencedMultipleSources[T[_]](readableTypes: T[ReadableSource])(implicit t: Traverse[T], ap: Applicative[Try]): Try[T[Model[A, B]]]

def fromUrl(u: URL): Try[Model[A, B]]

def fromVfs1(foVfs1: FileObject): Try[Model[A, B]]

def fromVfs2(foVfs2: FileObject): Try[Model[A, B]]

final def getClass(): Class[_]

def gz: FileReadableByInputStream[Try[Model[A, B]]] with MultipleFileReadable[Try[Model[A, B]]]

def hashCode(): Int

final def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

final def info(msg: ⇒ Any): Unit

val inputCharset: String

final def isDebugEnabled: Boolean

final def isErrorEnabled: Boolean

final def isInfoEnabled: Boolean

final def isInstanceOf[T0]: Boolean

final def isTraceEnabled: Boolean

final def isWarnEnabled: Boolean

final lazy val logger: Logger

def loggerInitName(): String

final def loggerName: String

val mapper: (ReadableSource) ⇒ Try[Model[A, B]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

final def trace(msg: ⇒ Any): Unit

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

final def warn(msg: ⇒ Any): Unit

Inherited from Logging

Inherited from SequenceMultipleReadable[ReadableSource, Try, Model[A, B]]

Inherited from MultipleAlohaReadable[Try[Model[A, B]]]

Inherited from MultipleReadable[ReadableSource, Try[Model[A, B]]]

Inherited from LocationLoggingReadable[Try[Model[A, B]]]

Inherited from GZippedReadable[Try[Model[A, B]]]

Inherited from ReadableByString[Try[Model[A, B]]]

Inherited from FileReadableByInputStream[Try[Model[A, B]]]

Inherited from AlohaReadable[Try[Model[A, B]]]

Inherited from NonFileReadable[Try[Model[A, B]]]

Inherited from FileReadable[Try[Model[A, B]]]

Inherited from AnyRef

Inherited from Any

Ungrouped