com.bowstreet.profiles
Interface SegmentList

public interface SegmentList

This Interface is used to support UI components that need to expose the named segments for a given Handler. Tools such as a Profile Customizers will use this interface to display a list of valid segments that can be assigned to a Profile. Implementing this interface is optional for defining a handler definition. To specify an implementation of a SegmentList interface for a handler you need to set the "class" attribute of the "SegmentList" element in your handler definition file. For example: <SegmentList class="com.bowstreet.profiles.FileSegmentSelectionHandler" />

Method Summary

java.util.Iterator	getSegments(ProfileSet profileSet) Gets an Iterator of the segment names related to this handler.
void	init(java.util.Map properties) Initialization method that is used to pass handler properties to implementers of the SegmentList interface.

Method Detail

getSegments

java.util.Iterator getSegments(ProfileSet profileSet)

Gets an Iterator of the segment names related to this handler.

Parameters:

profileSet - The ProfileSet, for the profile being selected. Note - The ProfileSet is not populated with all of the Profiles and should not be used to search for matching segments. The ProfileSet will typically contain only the structural information and the default Profile.

Returns:

An Iterator of segment names as java.lang.String objects.

init

void init(java.util.Map properties)

Initialization method that is used to pass handler properties to implementers of the SegmentList interface. Implementers of this interface should use this method to do any required Initialization before the getSegments(..) method is called.

Parameters:

properties - A Map of name value pairs specified in the handler definition file. The Map key and values are both of type java.lang.String.