Real Time Information Director User Documentation

RTID Metadata Language
Hewlett-Packard Company 38 529618-002
Segment
Segment defines a segment that does NOT introduce a new record into the data store.
Use Segment only when the segment does not occur more than once within any instance
of the parent segment.
The usual way to handle custom fields in an RTSC solution is to wrap them in a segment
with a name beginning with “Z”.
Segment has the following parameters:
• String tagName. This parameter is the XML tag that identifies the segment and is
required.
• TagDefinitions[] tagDefinitions. This array of tag definitions specifies which data
elements in the segment should be mapped to which columns in the data store and
is required.
• SegmentFormatter segmentFormatter. This optional parameter specifies custom
logic to be applied to the whole record. For more information, see “Segment
Formatter Classes.”
RecordSegment is, incidentally, a subclass of Segment.
Here are the possible constructors for the Segment class:
public Segment(String tagName, TagDefinition tagDefinition)
public Segment(String tagName, TagDefinition tagDefinition,
SegmentFormatter segmentFormatter)
public Segment(String tagName, TagDefinition[] tagDefinitions)
public Segment(String tagName, SegmentFormatter segmentFormatter,
TagDefinition[] tagDefinitions)
Inheriting Columns
Each nested RecordSegment has automatic access to columns in the parent and
grandparent RecordSegments. This inheritance is especially important because key
columns for the parent records usually must be included in the child (detail) records.
A column may be used in
• The table identified in the owning RecordSegment
• Tables identified in directly nested (child) RecordSegments
• Tables identified in indirectly nested (descendant) RecordSegments
• Any combination of the above
• None of the above