Class/Object

org.cert.netsa.io.ipfix

Record

Related Docs: object Record | package ipfix

Permalink

abstract class Record extends AnyRef

A Record instance represents an IPFIX data record. Each record contains a set of values which are described by the record's Template.

Each IPFIX data type can be mapped to its Java data type as in the table below:

1 The Seq[Byte] returned for octetArray or macAddress is a read-only view on the underlying record data. If you want to save the data without keeping the full record data from being garbage collected, you should copy the Seq.

2 Long is signed, so an unsigned64 with its high bit set will appear as negative.

3 The Seq[Byte] returned for a macAddress will always be of length 6.

A record's fields are described by a Template, which may be retrieved from the record using the #template value. Using the data from the template, the user can cast the record's objects to the appropriate Java type.

Alternatively, a record's values can be retrieved in a typed manner using either a FieldExtractor, or a Fillable object. A FieldExtractor acts as a reference to a particular field in a record regardless of the current template of the record. A Fillable object is an object which contains fields that have been marked with the IPFIXExtract annotation. A record's fill() method can be used to "fill in" the object's fields from the record.

See also

Template

Fillable

FieldExtractor

Linear Supertypes
AnyRef, Any
Known Subclasses
ArrayRecord, CollectedRecord, ExportRecord
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Record
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Record(template: Template)

    Permalink

    template

    The Template that describes this Record.

    Attributes
    protected

Abstract Value Members

  1. abstract def apply(idx: Int): Any

    Permalink

    The value of the field in this record at the given field position within the Template.

    The value of the field in this record at the given field position within the Template.

    Exceptions thrown

    java.lang.IndexOutOfBoundsException if the index is out of range.

  2. abstract def detach(): Record

    Permalink

    Modifies the current record so that it carries as little data as necessary to exist by itself.

    Modifies the current record so that it carries as little data as necessary to exist by itself. More specifically, it detaches itself from as much of its parent Message's data as possible. If non-complete subsets of Records are going to be kept in memory, they should be detached so they don't carry the memory of any discarded Records by association to their parent Messages.

    returns

    the record itself (not a new record)

  3. abstract def exportTime: Option[Instant]

    Permalink

    Gets the export time of the Message that generated this record as an Option.

    Gets the export time of the Message that generated this record as an Option.

    returns

    The export time of the Message or None if the record represents a list element or was not read from a Message.

  4. abstract def message: Option[Message]

    Permalink

    Returns the Message object from which the Record was read as an Option or scala.None if the Record was not read from a Message.

  5. abstract def observationDomain: Option[Int]

    Permalink

    Returns the observation domain of the Message that generated this record as an Option or None if the record represents a list element or was not read from a Message.

  6. abstract def octetLength: Int

    Permalink

    Gets the number of octets required to write the record to a stream.

Concrete 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 allBasicListElements(): Set[InfoElement]

    Permalink

    Gets a Set containing the InfoElement used by any basic list on the record and by the record's ListElements.

  5. final def allTemplates(): Set[Template]

    Permalink

    Gets a Set containing the Template used by the record and the Templates used by any ListElements in the record.

  6. def apply(ie: InfoElement): Any

    Permalink

    The value of the first occurrence of the specified Information Element in this Record.

    The value of the first occurrence of the specified Information Element in this Record.

    Since

    1.3.1

    Exceptions thrown

    java.lang.IndexOutOfBoundsException if this Record's Template does not contain that Information Element.

  7. def apply(spec: FieldSpec): Any

    Permalink

    The value of the field within this record matching the given specification.

    The value of the field within this record matching the given specification.

    Since

    1.3.1

    Exceptions thrown

    java.lang.IndexOutOfBoundsException if the Template does not contain the FieldSpec.

  8. final def apply[T](extractor: FieldExtractor[T]): Option[T]

    Permalink

    Gets the value within the record for the field referenced by the extractor as an Option.

    Gets the value within the record for the field referenced by the extractor as an Option.

    T

    The result type of the extractor.

    extractor

    A field extractor.

    returns

    The value for the referenced field, or scala.None if the extractor does not match a field in this record.

  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def fields: Iterator[Field]

    Permalink

    Returns an Iterator where iteration yields a Field.

  14. final def fill(obj: Fillable): Unit

    Permalink

    Fills the fields of obj that are marked with the IPFIXExtract annotation from this record.

    Fills the fields of obj that are marked with the IPFIXExtract annotation from this record.

    obj

    the object to fill

    See also

    IPFIXExtract

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted: String

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final lazy val size: Int

    Permalink

    Gets the number of fields in the record.

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

    Permalink
    Definition Classes
    AnyRef

  25. final val template: Template

    Permalink

    The Template that describes this Record.

  26. def toBuffer(outbuf: ByteBuffer, session: Session): ByteBuffer

    Permalink

    Appends this Record to a buffer for writing to an IPFIX stream.

    Appends this Record to a buffer for writing to an IPFIX stream. The function uses the template IDs in session if the Record contains SubTemplateLists or a SubTemplateMultiList. Assumes the Template(s) used by the Record have already been added to the Session and appeneded to the buffer.

  27. def toString(): String

    Permalink
    Definition Classes
    Record → AnyRef → Any

  28. final def wait(): Unit

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

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

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

  30. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped