Template
Related Docs:
object Template
| package ipfix
Returns the InfoElement at position idx.
Returns true if this Template contains the given InfoElement.
Returns true if this Template contains the given InfoElement.
1.3.1
Returns true if this Template contains an element that matches the given field specifier.
Returns true if this Template contains an element that matches the given field specifier.
1.3.1
Returns true if this Template contains *any* of the InfoElements in
ieIterable.
Returns true if this Template contains *any* of the InfoElements in
ieIterable.
1.3.1
Indicates whether the template contains at least one structured data element (that is, a BasicList, SubTemplateList, or SubTemplateMultiList).
Indicates whether the template contains at least one variable-length element.
A description for this Template; None not set.
Returns the length of the element at position idx as specified
by the IEFieldSpecifier.
Determines whether two templates are equal.
Determines whether two templates are equal. To be equal, two templates must have the same scope, the same set of elements, the same element order, and all elements must have the same length.
Determines if two templates have the same set of elements in the same order with the same lengths.
Determines if two templates have the same set of elements in the
same order with the same lengths. This method is similar to
equals() but it does not consider the scope.
Returns the position of the first occurrence of the given information element in this Template or returns -1 if the element is not found.
Returns the position of the given information element in this
template occurring at or after from or returns -1 if the
element is not found.
Returns the position of the InfoElement in this Template that matches the given field specifier or returns -1 if the element is not found.
Returns true if this Template is an information element meta-data template.
Returns true if this Template is an information element meta-data template.
An information element meta-data template is used to by records
to provide the name, ID, data-type, units, semantics, and range
of an information element that is not part of the standard
information model. Specifically, the method tests whether the
elements informationElementId and informationElementName are
present.
Returns true if this Template is a meta-data template.
Returns true if this Template is a meta-data template.
A meta-data template is used to by records that describe an information element or a template.
Returns true if this Template is an options template.
Returns true if this Template is an options template.
An options template is one whose scope is non-zero.
Returns true if this Template is a template meta-data template.
Returns true if this Template is a template meta-data template.
A template meta-data template is used to by records to provide a
name and an optional description to a template. Specifically,
the method tests whether the elements templateId and
templateName are present.
Returns true if this Template is a withdrawal template.
Returns true if this Template is a withdrawal template.
A withdrawal template is one that contains no elements.
Returns an iterator over the elements in the Template.
Returns an iterator over the elements in the Template. Each iteration returns a Tuple2 containing an InfoElement and its length in this Template.
Gives the number of octets required to hold the shortest record described by this Template.
A name used to identify this Template; None if not set.
Returns the number of octets required to write this template definition to an IPFIX stream.
Returns the number of octets required to write this template definition to an IPFIX stream.
minimumLength for the mininum length of a record that
uses this template.
The scope if this is an options template or 0
Returns the number of elements in this Template.
Appends the Template to a buffer for writing to an IPFIX stream.
Appends the Template to a buffer for writing to an IPFIX stream. Adds the Template to the Session if necessary.
java.nio.BufferOverflowException if there is not enough
room in the buffer for the Template. Because the method makes
multiple writes to the buffer, the buffer's position is unknown
if an error is thrown.
Returns a String describing this Template.
Returns a String describing this Template. If expandIEs is false,
includes only the name and element length for each IE in the Template
(like toString()). If expandIEs is true, includes a complete
description of each IE (including its type, ID, etc).
An IPFIX template that describes the data in a Record.
A template is composed of a sequence of information elements with associated lengths. (The IEFieldSpecifier class bundles the InfoElement and length into a single object.) An element's length in the template may be different than the "natural" length (reduced length encoding), and an element that supports variable-length values may have a fixed size.
If a template has a non-zero scope, the template is an Options Template.
When a Template is added to a Session it is given a unique ID within that Session. A Template may be added to multiple Sessions; there is not necessarily a relationship among the IDs given to a Template in the different Sessions.
1.3.1 The description is set and fixed at Template creation.