Package org.apache.unomi.api.segments

Class Segment

java.lang.Object

org.apache.unomi.api.Item

org.apache.unomi.api.MetadataItem

org.apache.unomi.api.segments.Segment

All Implemented Interfaces:

Serializable

public class Segment
extends MetadataItem

A dynamically evaluated group of similar profiles in order to categorize the associated users. To be considered part of a given segment, users must satisfies the segment’s condition. If they match, users are automatically added to the segment. Similarly, if at any given point during, they cease to satisfy the segment’s condition, they are automatically removed from it.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ITEM_TYPE	The Segment ITEM_TYPE.

Fields inherited from class org.apache.unomi.api.MetadataItem

metadata

Fields inherited from class org.apache.unomi.api.Item

itemId, itemType, scope, systemMetadata, version

Constructor Summary

Constructors

Constructor	Description
Segment()	Instantiates a new Segment.
Segment(Metadata metadata)	Instantiates a new Segment with the specified metadata.

Method Summary

Modifier and Type	Method	Description
Condition	getCondition()	Retrieves the condition that users' Profile must satisfy in order to be considered member of this Segment.
void	setCondition(Condition condition)	Sets the condition that users' Profile must satisfy in order to be considered member of this Segment.

Methods inherited from class org.apache.unomi.api.MetadataItem

getMetadata, getScope, setMetadata

Methods inherited from class org.apache.unomi.api.Item

equals, getItemId, getItemType, getItemType, getSystemMetadata, getVersion, hashCode, setItemId, setItemType, setScope, setSystemMetadata, setVersion

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ITEM_TYPE

public static final String ITEM_TYPE

The Segment ITEM_TYPE.

See Also:

• for a discussion of ITEM_TYPE
• Constant Field Values

Constructor Details

Segment

public Segment()

Instantiates a new Segment.

Segment

public Segment(Metadata metadata)

Instantiates a new Segment with the specified metadata.

Parameters:

metadata - the metadata

Method Details

getCondition

public Condition getCondition()

Retrieves the condition that users' Profile must satisfy in order to be considered member of this Segment.

Returns:

the condition that users must match

setCondition

public void setCondition(Condition condition)

Sets the condition that users' Profile must satisfy in order to be considered member of this Segment.

Parameters:

condition - the condition that users must match