Class CQ_Analytics.SegmentMgr

Package:	CQ_Analytics
Class:	SegmentMgr
Extends:	CQ_Analytics.SessionStore
Clientlib:	personalization.core

Public Properties

Public Methods

Method		Defined By
	SegmentMgr.loadSegments( String path ) : void <static> Loads the segments at URL: path + ".segment.js". Fires "segmentsload" event. <static> Loads the segments at URL: path + ".segment.js". Fires "segmentsload" event. Parameters: path : String Path from where segments are loaded Returns: void Added in CQ 5.5.	SegmentMgr
	SegmentMgr.renderer( CQ_Analytics.SessionStore store, String targetId ) : void <static> Renders the current segments found in the SegmentMgr store. Rendering is appended to the provided targ... <static> Renders the current segments found in the SegmentMgr store. Rendering is appended to the provided target id. Parameters: store : CQ_Analytics.SessionStore The SegmentMgr store targetId : String The target id Returns: void Added in CQ 5.5.	SegmentMgr
	addInitProperty( String name, String value ) : void Adds an initial property to the store. Adds an initial property to the store. Parameters: name : String Property name. value : String Property value. Returns: void	SessionStore
	addListener( String event, Function fct, [Object scope] ) : void Appends an event handler to the current Observable. Appends an event handler to the current Observable. Parameters: event : String Event name. fct : Function The method the event invokes. scope : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. Returns: void	Observable
	clear() : void Clears the store. Clears the store. Parameters: None. Returns: void	SessionStore
	getBoost( Array segmentPath ) : Number Returns the boost of a segment. Returns the boost of a segment. Parameters: segmentPath : Array Path of the segment Returns: Number Boost of the segment.	SegmentMgr
	getData( String[] excluded ) : Object Returns the store data. Returns the store data. Parameters: excluded : String[] Property names to exclude from the result. Returns: Object Object containing the store data (obj["property"] = value).	SessionStore
	getInitProperty( String name ) : String Returns the value of an initial property. Returns the value of an initial property. Parameters: name : String Property name. Returns: String The value.	SessionStore
	getLabel( String name ) : String Returns a store property friendly label. Returns a store property friendly label. Parameters: name : String Property name. Returns: String the label.	SessionStore
	getLink( String name ) : String Returns a store property in a link format. Returns a store property in a link format. Parameters: name : String Property name. Returns: String the link value.	SessionStore
	getMaxBoost( String[] segmentPaths, Object clientcontext ) : Number Returns the max boost of an array of segments. Segment must resolve the given clientcontext. Returns the max boost of an array of segments. Segment must resolve the given clientcontext. Parameters: segmentPaths : String[] Array of segment paths. clientcontext : Object Object containing values to try to resolve segments. Returns: Number The max boost of the resolving segments.	SegmentMgr
	getName() : void Returns the store name. Returns the store name. Parameters: None. Returns: void	SessionStore
	getProperty( String name, Boolean raw ) : String Returns the value of a store property (XSS filtered value). Returns the value of a store property (XSS filtered value). Parameters: name : String Property name. raw : Boolean Raw value, no XSS filtering Returns: String the value.	SessionStore
	getPropertyNames( [String[] excluded] ) : String[] Returns all store property names. Returns all store property names. Parameters: excluded : String[] (Optional) Array of excluded properties (not returned). Returns: String[] Array of the property names.	SessionStore
	getResolved( Object clientcontext ) : String[] Returns all resolving segments for the given clientcontext. Returns all resolving segments for the given clientcontext. Parameters: clientcontext : Object Object containing values to try to resolve segments. Returns: String[] Array of resolving segments.	SegmentMgr
	getSessionStore() : CQ_Analytics.SessionStore Returns the session store attached to the current object (returns this). Returns the session store attached to the current object (returns this). Parameters: None. Returns: CQ_Analytics.SessionStore Session store.	SessionStore
	init() : void Initializes the store. Initializes the store. Parameters: None. Returns: void	SessionStore
	isInitialized() : void Returns true if the store is initialized. False otherwise. Returns true if the store is initialized. False otherwise. Parameters: None. Returns: void	SessionStore
	loadInitProperties( Object obj, Boolean setValues ) : void Loads initial properties from an object. Loads initial properties from an object. Parameters: obj : Object Object containing the initial store data (obj["property"] = value). setValues : Boolean True to set the value in the store IF property does is not already present Returns: void	SessionStore
	register( String segmentPath, String rule, [Number boost] ) : void Registers a segment. Registers a segment. Parameters: segmentPath : String Path to the segment. rule : String Boolean JS expression defining the segment. boost : Number (Optional) Segment boost (defaults to 0). Returns: void	SegmentMgr
	reload( String path ) : void Reloads the given segment. Reloads the given segment. Parameters: path : String Path to the segment. Returns: void	SegmentMgr
	removeListener( String event, Function fct ) : void Removes an event handler from the current Observable. Removes an event handler from the current Observable. Parameters: event : String Event name. fct : Function The method the event invokes. Returns: void	Observable
	removeProperty( String name ) : void Removes a property from the store. Removes a property from the store. Parameters: name : String Property name. Returns: void	SessionStore
	reset() : void Resets the store: restores initial values. Resets the store: restores initial values. Parameters: None. Returns: void	SessionStore
	resolve( String segmentPath, Object clientcontext ) : Boolean/String Resolves a segment. Tries to eval the rule of the segment the given clientcontext object. Resolves a segment. Tries to eval the rule of the segment the given clientcontext object. Parameters: segmentPath : String Segment path. clientcontext : Object Object containing values to try to resolve segments. Returns: Boolean/String True if resolution success, false otherwise. String containing error description if any execption occurs during resolution.	SegmentMgr
	resolveArray( String[] segmentPaths, Object clientcontext, [String operator] ) : Boolean/String Resolves an array of segments. Resolution depends on operator: operator is AND: success if all segments of array reso... Resolves an array of segments. Resolution depends on operator: operator is AND: success if all segments of array resolve. operator is OR: success when finding one segment of array resolving. Parameters: segmentPaths : String[] Array of segment paths. clientcontext : Object Object containing values to try to resolve segments. operator : String (Optional) Operator: "OR" / "AND" (defaults to "OR"). Returns: Boolean/String True if resolution success, false otherwise. String containing error description if any execption occurs during resolution.	SegmentMgr
	setProperties( Object values ) : void Sets the value of multiple properties Sets the value of multiple properties Parameters: values : Object The key-value store of values to set Returns: void	SessionStore
	setProperty( String name, String value ) : void Sets the value of a property. Sets the value of a property. Parameters: name : String Property name. value : String Property value. Returns: void	SessionStore
	setSuppressEvents( Boolean suppressEvents ) : void Sets the value of the suppressEvents property Sets the value of the suppressEvents property Parameters: suppressEvents : Boolean Returns: void	Observable

Public Events