final class TemplateSet extends IpfixSet with Iterable[Template]
A TemplateSet represents a IpfixSet that contains one or more Templates or Option Templates.
To create a TemplateSet from an input ByteBuffer, use IpfixSet.fromBuffer.
To create a TemplateSet for export, use TemplateSet.empty to create an empty TemplateSet and then call TemplateSet.addTemplate to add Templates to it.
- See also
The companion object for more details.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- TemplateSet
- Iterable
- IterableFactoryDefaults
- IterableOps
- IterableOnceOps
- IterableOnce
- IpfixSet
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ++[B >: Template](suffix: IterableOnce[B]): Iterable[B]
- Definition Classes
- IterableOps
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def addString(b: StringBuilder): StringBuilder
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- final def addString(b: StringBuilder, sep: String): StringBuilder
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
- Definition Classes
- IterableOnceOps
- def addTemplate(tmpl: Template): TemplateSet
Adds a Template to the TemplateSet.
Adds a Template to the TemplateSet. The Option setting of the Template must match that of the Template Set.
- Exceptions thrown
MessageTooLongExceptionwhen adding the Template would cause the size of the exported Template Set to exceed the maximum IPFIX message size.java.lang.RuntimeExceptionwhen either the Template Set is read-only or the isOptionsTemplate setting of the Template does not match that of the Template Set.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def className: String
- Attributes
- protected[this]
- Definition Classes
- Iterable
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def coll: TemplateSet.this.type
- Attributes
- protected
- Definition Classes
- Iterable → IterableOps
- def collect[B](pf: PartialFunction[Template, B]): Iterable[B]
- Definition Classes
- IterableOps → IterableOnceOps
- def collectFirst[B](pf: PartialFunction[Template, B]): Option[B]
- Definition Classes
- IterableOnceOps
- def concat[B >: Template](suffix: IterableOnce[B]): Iterable[B]
- Definition Classes
- IterableOps
- def copyToArray[B >: Template](xs: Array[B], start: Int, len: Int): Int
- Definition Classes
- IterableOnceOps
- def copyToArray[B >: Template](xs: Array[B], start: Int): Int
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecatedOverriding()
- def copyToArray[B >: Template](xs: Array[B]): Int
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecatedOverriding()
- def corresponds[B](that: IterableOnce[B])(p: (Template, B) => Boolean): Boolean
- Definition Classes
- IterableOnceOps
- def count(p: (Template) => Boolean): Int
- Definition Classes
- IterableOnceOps
- def drop(n: Int): Iterable[Template]
- Definition Classes
- IterableOps → IterableOnceOps
- def dropRight(n: Int): Iterable[Template]
- Definition Classes
- IterableOps
- def dropWhile(p: (Template) => Boolean): Iterable[Template]
- Definition Classes
- IterableOps → IterableOnceOps
- def empty: Iterable[Template]
- Definition Classes
- IterableFactoryDefaults → IterableOps
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def exists(p: (Template) => Boolean): Boolean
- Definition Classes
- IterableOnceOps
- def filter(pred: (Template) => Boolean): Iterable[Template]
- Definition Classes
- IterableOps → IterableOnceOps
- def filterNot(pred: (Template) => Boolean): Iterable[Template]
- Definition Classes
- IterableOps → IterableOnceOps
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def find(p: (Template) => Boolean): Option[Template]
- Definition Classes
- IterableOnceOps
- def flatMap[B](f: (Template) => IterableOnce[B]): Iterable[B]
- Definition Classes
- IterableOps → IterableOnceOps
- def flatten[B](implicit asIterable: (Template) => IterableOnce[B]): Iterable[B]
- Definition Classes
- IterableOps → IterableOnceOps
- def fold[A1 >: Template](z: A1)(op: (A1, A1) => A1): A1
- Definition Classes
- IterableOnceOps
- def foldLeft[B](z: B)(op: (B, Template) => B): B
- Definition Classes
- IterableOnceOps
- def foldRight[B](z: B)(op: (Template, B) => B): B
- Definition Classes
- IterableOnceOps
- def forall(p: (Template) => Boolean): Boolean
- Definition Classes
- IterableOnceOps
- def foreach[U](f: (Template) => U): Unit
- Definition Classes
- IterableOnceOps
- def fromSpecific(coll: IterableOnce[Template]): Iterable[Template]
- Attributes
- protected
- Definition Classes
- IterableFactoryDefaults → IterableOps
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def groupBy[K](f: (Template) => K): Map[K, Iterable[Template]]
- Definition Classes
- IterableOps
- def groupMap[K, B](key: (Template) => K)(f: (Template) => B): Map[K, Iterable[B]]
- Definition Classes
- IterableOps
- def groupMapReduce[K, B](key: (Template) => K)(f: (Template) => B)(reduce: (B, B) => B): Map[K, B]
- Definition Classes
- IterableOps
- def grouped(size: Int): Iterator[Iterable[Template]]
- Definition Classes
- IterableOps
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def head: Template
- Definition Classes
- IterableOps
- def headOption: Option[Template]
- Definition Classes
- IterableOps
- final val id: Int
- Definition Classes
- IpfixSet
- def init: Iterable[Template]
- Definition Classes
- IterableOps
- def inits: Iterator[Iterable[Template]]
- Definition Classes
- IterableOps
- def isEmpty: Boolean
- Definition Classes
- IterableOnceOps
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val isOptionsTemplate: Boolean
Indicates whether this template set holds option templates.
- def isTraversableAgain: Boolean
- Definition Classes
- IterableOps → IterableOnceOps
- def iterableFactory: IterableFactory[Iterable]
- Definition Classes
- Iterable → IterableOps
- def iterator: Iterator[Template]
Returns an Iterator over the Templates in the Set.
Returns an Iterator over the Templates in the Set.
- Definition Classes
- TemplateSet → IterableOnce
- def knownSize: Int
- Definition Classes
- IterableOnce
- def last: Template
- Definition Classes
- IterableOps
- def lastOption: Option[Template]
- Definition Classes
- IterableOps
- def lazyZip[B](that: Iterable[B]): LazyZip2[Template, B, TemplateSet.this.type]
- Definition Classes
- Iterable
- def map[B](f: (Template) => B): Iterable[B]
- Definition Classes
- IterableOps → IterableOnceOps
- def max[B >: Template](implicit ord: Ordering[B]): Template
- Definition Classes
- IterableOnceOps
- def maxBy[B](f: (Template) => B)(implicit cmp: Ordering[B]): Template
- Definition Classes
- IterableOnceOps
- def maxByOption[B](f: (Template) => B)(implicit cmp: Ordering[B]): Option[Template]
- Definition Classes
- IterableOnceOps
- def maxOption[B >: Template](implicit ord: Ordering[B]): Option[Template]
- Definition Classes
- IterableOnceOps
- def min[B >: Template](implicit ord: Ordering[B]): Template
- Definition Classes
- IterableOnceOps
- def minBy[B](f: (Template) => B)(implicit cmp: Ordering[B]): Template
- Definition Classes
- IterableOnceOps
- def minByOption[B](f: (Template) => B)(implicit cmp: Ordering[B]): Option[Template]
- Definition Classes
- IterableOnceOps
- def minOption[B >: Template](implicit ord: Ordering[B]): Option[Template]
- Definition Classes
- IterableOnceOps
- final def mkString: String
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- final def mkString(sep: String): String
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- final def mkString(start: String, sep: String, end: String): String
- Definition Classes
- IterableOnceOps
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newSpecificBuilder: Builder[Template, Iterable[Template]]
- Attributes
- protected
- Definition Classes
- IterableFactoryDefaults → IterableOps
- def nonEmpty: Boolean
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecatedOverriding()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def octetLength: Int
Returns the total octetLength of this TemplateSet when reading from or writing to a buffer.
- def partition(p: (Template) => Boolean): (Iterable[Template], Iterable[Template])
- Definition Classes
- IterableOps
- def partitionMap[A1, A2](f: (Template) => Either[A1, A2]): (Iterable[A1], Iterable[A2])
- Definition Classes
- IterableOps
- def product[B >: Template](implicit num: Numeric[B]): B
- Definition Classes
- IterableOnceOps
- def recordIterator: Iterator[Record]
Returns an Iterator over the Records in this IpfixSet, returning an empty Iterator if this is a TemplateSet.
Returns an Iterator over the Records in this IpfixSet, returning an empty Iterator if this is a TemplateSet.
- Definition Classes
- IpfixSet
- def reduce[B >: Template](op: (B, B) => B): B
- Definition Classes
- IterableOnceOps
- def reduceLeft[B >: Template](op: (B, Template) => B): B
- Definition Classes
- IterableOnceOps
- def reduceLeftOption[B >: Template](op: (B, Template) => B): Option[B]
- Definition Classes
- IterableOnceOps
- def reduceOption[B >: Template](op: (B, B) => B): Option[B]
- Definition Classes
- IterableOnceOps
- def reduceRight[B >: Template](op: (Template, B) => B): B
- Definition Classes
- IterableOnceOps
- def reduceRightOption[B >: Template](op: (Template, B) => B): Option[B]
- Definition Classes
- IterableOnceOps
- def reversed: Iterable[Template]
- Attributes
- protected
- Definition Classes
- IterableOnceOps
- def scan[B >: Template](z: B)(op: (B, B) => B): Iterable[B]
- Definition Classes
- IterableOps
- def scanLeft[B](z: B)(op: (B, Template) => B): Iterable[B]
- Definition Classes
- IterableOps → IterableOnceOps
- def scanRight[B](z: B)(op: (Template, B) => B): Iterable[B]
- Definition Classes
- IterableOps
- final val session: Session
- Definition Classes
- IpfixSet
- def size: Int
Returns the number of Templates in the Set.
Returns the number of Templates in the Set.
- Definition Classes
- TemplateSet → IterableOnceOps → IpfixSet
- def sizeCompare(that: Iterable[_]): Int
- Definition Classes
- IterableOps
- def sizeCompare(otherSize: Int): Int
- Definition Classes
- IterableOps
- final def sizeIs: SizeCompareOps
- Definition Classes
- IterableOps
- Annotations
- @inline()
- def slice(from: Int, until: Int): Iterable[Template]
- Definition Classes
- IterableOps → IterableOnceOps
- def sliding(size: Int, step: Int): Iterator[Iterable[Template]]
- Definition Classes
- IterableOps
- def sliding(size: Int): Iterator[Iterable[Template]]
- Definition Classes
- IterableOps
- def span(p: (Template) => Boolean): (Iterable[Template], Iterable[Template])
- Definition Classes
- IterableOps → IterableOnceOps
- def splitAt(n: Int): (Iterable[Template], Iterable[Template])
- Definition Classes
- IterableOps → IterableOnceOps
- def stepper[S <: Stepper[_]](implicit shape: StepperShape[Template, S]): S
- Definition Classes
- IterableOnce
- def stringPrefix: String
- Attributes
- protected[this]
- Definition Classes
- Iterable
- Annotations
- @deprecatedOverriding()
- def sum[B >: Template](implicit num: Numeric[B]): B
- Definition Classes
- IterableOnceOps
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tail: Iterable[Template]
- Definition Classes
- IterableOps
- def tails: Iterator[Iterable[Template]]
- Definition Classes
- IterableOps
- def take(n: Int): Iterable[Template]
- Definition Classes
- IterableOps → IterableOnceOps
- def takeRight(n: Int): Iterable[Template]
- Definition Classes
- IterableOps
- def takeWhile(p: (Template) => Boolean): Iterable[Template]
- Definition Classes
- IterableOps → IterableOnceOps
- def tapEach[U](f: (Template) => U): Iterable[Template]
- Definition Classes
- IterableOps → IterableOnceOps
- def templateIterator: Iterator[Template]
Returns an Iterator over the Templates in this IpfixSet, returning an empty Iterator if this is a RecordSet.
Returns an Iterator over the Templates in this IpfixSet, returning an empty Iterator if this is a RecordSet.
- Definition Classes
- IpfixSet
- def to[C1](factory: Factory[Template, C1]): C1
- Definition Classes
- IterableOnceOps
- def toArray[B >: Template](implicit arg0: ClassTag[B]): Array[B]
- Definition Classes
- IterableOnceOps
- def toBuffer(outbuf: ByteBuffer): ByteBuffer
Appends the TemplateSet to a buffer for writing to an IPFIX stream.
Appends the TemplateSet to a buffer for writing to an IPFIX stream.
- Definition Classes
- TemplateSet → IpfixSet
- Exceptions thrown
java.nio.BufferOverflowExceptionif there is not enough room in the buffer for all Templates in the TemplateSet. Because the method makes multiple writes to the buffer, the buffer's position is unknown if an error is thrown.
- final def toBuffer[B >: Template]: Buffer[B]
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- def toIndexedSeq: IndexedSeq[Template]
- Definition Classes
- IterableOnceOps
- def toList: List[Template]
- Definition Classes
- IterableOnceOps
- def toMap[K, V](implicit ev: <:<[Template, (K, V)]): Map[K, V]
- Definition Classes
- IterableOnceOps
- def toSeq: Seq[Template]
- Definition Classes
- IterableOnceOps
- def toSet[B >: Template]: Set[B]
- Definition Classes
- IterableOnceOps
- def toString(): String
- Definition Classes
- Iterable → AnyRef → Any
- def toVector: Vector[Template]
- Definition Classes
- IterableOnceOps
- def transpose[B](implicit asIterable: (Template) => Iterable[B]): Iterable[Iterable[B]]
- Definition Classes
- IterableOps
- def unzip[A1, A2](implicit asPair: (Template) => (A1, A2)): (Iterable[A1], Iterable[A2])
- Definition Classes
- IterableOps
- def unzip3[A1, A2, A3](implicit asTriple: (Template) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])
- Definition Classes
- IterableOps
- def view: View[Template]
- Definition Classes
- IterableOps
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withFilter(p: (Template) => Boolean): WithFilter[Template, Iterable]
- Definition Classes
- IterableOps
- def zip[B](that: IterableOnce[B]): Iterable[(Template, B)]
- Definition Classes
- IterableOps
- def zipAll[A1 >: Template, B](that: Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]
- Definition Classes
- IterableOps
- def zipWithIndex: Iterable[(Template, Int)]
- Definition Classes
- IterableOps → IterableOnceOps
Deprecated Value Members
- def ++:[B >: Template](that: IterableOnce[B]): Iterable[B]
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use ++ instead of ++: for collections of type Iterable
- final def /:[B](z: B)(op: (B, Template) => B): B
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use foldLeft instead of /:
- final def :\[B](z: B)(op: (Template, B) => B): B
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use foldRight instead of :\
- def aggregate[B](z: => B)(seqop: (B, Template) => B, combop: (B, B) => B): B
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0)
aggregateis not relevant for sequential collections. UsefoldLeft(z)(seqop)instead.
- def companion: IterableFactory[Iterable]
- Definition Classes
- IterableOps
- Annotations
- @deprecated @deprecatedOverriding() @inline()
- Deprecated
(Since version 2.13.0) Use iterableFactory instead
- final def copyToBuffer[B >: Template](dest: Buffer[B]): Unit
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use
dest ++= collinstead
- def hasDefiniteSize: Boolean
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)
- final def repr: Iterable[Template]
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use coll instead of repr in a collection implementation, use the collection value itself from the outside
- def seq: TemplateSet.this.type
- Definition Classes
- Iterable
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Iterable.seq always returns the iterable itself
- final def toIterable: TemplateSet.this.type
- Definition Classes
- Iterable → IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.7) toIterable is internal and will be made protected; its name is similar to
toListortoSeq, but it doesn't copy non-immutable collections
- final def toIterator: Iterator[Template]
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator instead of .toIterator
- final def toStream: Stream[Template]
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .to(LazyList) instead of .toStream
- final def toTraversable: Traversable[Template]
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) toTraversable is internal and will be made protected; its name is similar to
toListortoSeq, but it doesn't copy non-immutable collections
- def view(from: Int, until: Int): View[Template]
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .view.slice(from, until) instead of .view(from, until)
This is documentation for Mothra, a collection of Scala and Spark library functions for working with Internet-related data. Some modules contain APIs of general use to Scala programmers. Some modules make those tools more useful on Spark data-processing systems.
Please see the documentation for the individual packages for more details on their use.
Scala Packages
These packages are useful in Scala code without involving Spark:
org.cert.netsa.data
This package, which is collected as the
netsa-datalibrary, provides types for working with various kinds of information:org.cert.netsa.data.net- types for working with network dataorg.cert.netsa.data.time- types for working with time dataorg.cert.netsa.data.unsigned- types for working with unsigned integral valuesorg.cert.netsa.io.ipfix
The
netsa-io-ipfixlibrary provides tools for reading and writing IETF IPFIX data from various connections and files.org.cert.netsa.io.silk
To read and write CERT NetSA SiLK file formats and configuration files, use the
netsa-io-silklibrary.org.cert.netsa.util
The "junk drawer" of
netsa-utilso far provides only two features: First, a method for equipping Scala scala.collection.Iterators with exception handling. And second, a way to query the versions of NetSA libraries present in a JVM at runtime.Spark Packages
These packages require the use of Apache Spark:
org.cert.netsa.mothra.datasources
Spark datasources for CERT file types. This package contains utility features which add methods to Apache Spark DataFrameReader objects, allowing IPFIX and SiLK flows to be opened using simple
spark.read...calls.The
mothra-datasourceslibrary contains both IPFIX and SiLK functionality, whilemothra-datasources-ipfixandmothra-datasources-silkcontain only what's needed for the named datasource.org.cert.netsa.mothra.analysis
A grab-bag of analysis helper functions and example analyses.
org.cert.netsa.mothra.functions
This single Scala object provides Spark SQL functions for working with network data. It is the entirety of the
mothra-functionslibrary.