CollectedRecord

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def allBasicListElements(): Set[InfoElement]

   

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

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

   Definition Classes

   Record

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

   

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

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

   Definition Classes

   Record

6. def apply(idx: Int): Any

   

   Gets the value within the record for the given field by field position within the Template.

   Gets the value within the record for the given field by field position within the Template.

   idx

   The index of the field whose value to return.

   returns

   The value for the referenced field.

   Definition Classes

   CollectedRecord → Record

   Exceptions thrown

   if the index is out of range

   (idx < 0 || idx >= template.size())

7. def apply(ie: InfoElement): Any

   

   Gets the value within the record for the given field by finding the field matching an InfoElement within the Template.

   Gets the value within the record for the given field by finding the field matching an InfoElement within the Template.

   ie

   The InfoElement to find with the record's Template in order to get its position.

   returns

   The value for the referenced field.

   Definition Classes

   Record

   Since

   1.3.1

   Exceptions thrown

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

8. def apply(spec: FieldSpec): Any

   

   Gets the value within the record for the given field by finding the field matching a FieldSpec within the Template.

   Gets the value within the record for the given field by finding the field matching a FieldSpec within the Template.

   spec

   The field to find with the record's Template in order to get its position.

   returns

   The value for the referenced field.

   Definition Classes

   Record

   Since

   1.3.1

   Exceptions thrown

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

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

   

   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.

   Definition Classes

   Record

10. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

11. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

12. def detach(): Record

    

    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)

    Definition Classes

    CollectedRecord → Record

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

    

    Definition Classes

    AnyRef

14. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

15. def exportTime: Option[Instant]

    

    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.

    Definition Classes

    CollectedRecord → Record

16. final def fields: Iterator[Field]

    

    Returns an Iterator where iteration yields a Field.

    Returns an Iterator where iteration yields a Field.

    Definition Classes

    Record

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

    

    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

    Definition Classes

    Record

    See also

    IPFIXExtract

18. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

19. def formatted: String

    

    Definition Classes

    Record

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

    

    Definition Classes

    AnyRef → Any

21. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

22. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

23. val message: Option[Message]

    

    The message from which the record was read.

    The message from which the record was read.

    Definition Classes

    CollectedRecord → Record

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

    

    Definition Classes

    AnyRef

25. final def notify(): Unit

    

    Definition Classes

    AnyRef

26. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

27. def observationDomain: Option[Int]

    

    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.

    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.

    Definition Classes

    CollectedRecord → Record

28. def octetLength: Int

    

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

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

    Definition Classes

    CollectedRecord → Record

29. val session: Session

    

    The session object from which the ByteBuffers in data were read.

30. final lazy val size: Int

    

    Gets the number of fields in the record.

    Gets the number of fields in the record.

    Definition Classes

    Record

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

    

    Definition Classes

    AnyRef

32. final val template: Template

    

    The Template that describes this Record.

    The Template that describes this Record.

    Definition Classes

    Record

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

    

    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 appended to the buffer.

    Definition Classes

    CollectedRecord → Record

34. def toString(): String

    

    Definition Classes

    Record → AnyRef → Any

35. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )