Class/Object

org.cert.netsa.io.ipfix

InfoModel

Related Docs: object InfoModel | package ipfix

Permalink

final class InfoModel extends Serializable with LazyLogging

The InfoModel class represents the IPFIX Information Model.

The Information Model contains Information Elmenets.

To use the standard IPFIX Information Model, the caller invokes the getStandardInfoModel() method on the companion object. If necessary, that function reads the standard model from an XML file. The caller is given an empty model that inherits from the standard model. This allows the caller to manipulate the information model without invalidating the standard model or disrupting other threads.

See also

The companion object for more details.

Linear Supertypes
LazyLogging, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InfoModel
  2. LazyLogging
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def add(ie: InfoElement): Unit

    Permalink

    Adds the information element ie and the corresponding reverse element if there is a known function to do that mapping.

  5. def addReverseMapper(pen: Long): Option[MakeReversibleElement]

    Permalink

    Registers an object that creates a reverse InfoElement by masking the elementId of the element's Identifier by 0x4000 and prepending "reverse" to the element's name when the enterpriseId of the element is pen.

  6. def addReverseMapper(pen: Long, bits: Int): Option[MakeReversibleElement]

    Permalink

    Registers an object that creates a reverse InfoElement by masking the elementId of the element's Identifier by bits and prepending "reverse" to the element's name when the enterpriseId of the element is pen.

  7. def addReverseMapper(pen: Long, mre: MakeReversibleElement): Option[MakeReversibleElement]

    Permalink

    Registers the class or object mre as being the one to use when attempting to find the corresponding reverse InfoElement for an InfoElement whose enterpriseId is pen.

  8. def apply(name: String): InfoElement

    Permalink

    Gets the information element from the model that has the specified name.

    Gets the information element from the model that has the specified name.

    name

    Name of the element to retrieve

    Since

    1.3.1

    Exceptions thrown

    InvalidInfoElementException if an InfoElement is not found

  9. def apply(id: Identifier): InfoElement

    Permalink

    Gets the information element from the model that has the specified Identifier.

    Gets the information element from the model that has the specified Identifier.

    id

    Identifier of the element to retrieve

    Since

    1.3.1

    Exceptions thrown

    InvalidInfoElementException if an InfoElement is not found

  10. def apply(elementId: Int, enterpriseId: Long = 0L): InfoElement

    Permalink

    Gets the information element from the model that has the specified elementId and enterpriseId'.

    Gets the information element from the model that has the specified elementId and enterpriseId'.

    enterpriseId

    The Private Enterprise Number of the element to find.

    Since

    1.3.1

    Exceptions thrown

    InvalidInfoElementException if an InfoElement is not found

  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def contains(name: String): Boolean

    Permalink

    Returns true if this model contains an InfoElement that has the specified name.

    Returns true if this model contains an InfoElement that has the specified name. Returns false otherwise.

  14. def contains(id: Identifier): Boolean

    Permalink

    Returns true if this model contains an InfoElement that has the specified Identifier.

  15. def contains(elementId: Int, enterpriseId: Long = 0L): Boolean

    Permalink

    Returns true if this model contains an InfoElement that has the specified elementId and enterpriseId'; returns false otherwise. Also returns false if elementId or enterpriseId are outside the range of legal values.

    Returns true if this model contains an InfoElement that has the specified elementId and enterpriseId'; returns false otherwise. Also returns false if elementId or enterpriseId are outside the range of legal values.

    enterpriseId

    The Private Enterprise Number of the element to find.

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

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def get(name: String): Option[InfoElement]

    Permalink

    Gets the information element from the model that has the specified name as an Option.

  20. def get(id: Identifier): Option[InfoElement]

    Permalink

    Gets the information element from the model that has the specified identifier as an Option.

  21. def get(elementId: Int, enterpriseId: Long = 0L): Option[InfoElement]

    Permalink

    Gets the information element from the model that has the specified elementId and enterpriseId as an Option.

    Gets the information element from the model that has the specified elementId and enterpriseId as an Option. Returns None if elementId or enterpriseId are outside the range of legal values.

    enterpriseId

    The Private Enterprise Number of the element to find.

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

    Permalink
    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  24. def importElements(nodes: NodeSeq): Unit

    Permalink

    Creates an InfoElement from each node in nodes and adds that InfoElement to the InfoModel.

    Creates an InfoElement from each node in nodes and adds that InfoElement to the InfoModel.

    nodes

    The sequence of Nodes to parse

  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. def iterator: Iterator[InfoElement]

    Permalink

    Returns an Iterator to visit the InfoElements in the model.

  27. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  28. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  31. val parent: Option[InfoModel]

    Permalink

    The model that this model inherits from

  32. def remove(name: String): Option[InfoElement]

    Permalink

    Marks as deleted the information element that has the specified name.

    Marks as deleted the information element that has the specified name. Returns the deleted element.

  33. def remove(id: Identifier): Option[InfoElement]

    Permalink

    Marks as deleted the information element that has the specified identifier.

    Marks as deleted the information element that has the specified identifier. Returns the deleted element.

  34. def setCreateStandardReverse(withReverse: Boolean): Boolean

    Permalink

    Determines whether reverse elements are included with the standard model.

    Determines whether reverse elements are included with the standard model. Returns true if previous setting was to include reverse elements, and false if the previous setting was not to include reverse elements.

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

    Permalink
    Definition Classes
    AnyRef
  36. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit

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

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

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

Inherited from LazyLogging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped