Class actuate.xtabanalyzer.MemberValue

Description

The MemberValue class specifies a member value definition used for sort, filter, or drill functionality.

Constructor

Syntax

actuate.xtabanalyzer.MemberValue(levelName, value, (MemberValue))

Creates a MemberValue object for a given level and value. The object can contain multiple member values.

Parameters

levelName

String. Dimension level name of member.

value

String. Value for the member to contain.

MemberValue

Optional actuate.xtabanalyzer.MemberValue object. MemberValue object to add during construction.

Function summary

Table 5-14 lists actuate.xtabanalyzer.MemberValue functions.

Table 5-14  actuate.xtabanalyzer.MemberValue functions 

Function	Description
addMember( )	Adds a member value object.
getLevelName( )	Retrieves the level name.
getMembers( )	Retrieves an array of members.
getValue( )	Returns the level value.
setLevelName( )	Sets the level name.
setValue( )	Sets the member value.

actuate.xtabanalyzer.MemberValue.addMember

Syntax

void MemberValue.addMember(actuate.xtabanalyzer.MemberValue member)

Adds a member value.

Parameters

member

actuate.xtabanalyzer.MemberValue object.

Example

MemberValue is an embedded class that can be a single value or an array of values. This example has a single member that contains four members.

function addMembers(memberData){

  var mv1 = new MemberValue('dim/state','CA');

  var mv2 = new MemberValue('dim/state','CN');

  var mv3 = new MemberValue(memberData);

  var mv = new MemberValue('dim/country','USA');

  mv.addMember(mv1);

  mv.addMember(mv2);

  mv.addMember(mv3);

  return mv;

}

actuate.xtabanalyzer.MemberValue.getLevelName

Syntax

string MemberValue.getLevelName( )

Returns the level name of the member.

Returns

String. The level name.

Example

This example retrieves the level name for the member value.

function getLevelName(level){

  if (level){

    return level.getLevelName( );

  }

  return null;

}

actuate.xtabanalyzer.MemberValue.getMembers

Syntax

actuate.xtabanalyzer.MemberValue[ ] MemberValue.getMembers( )

Returns an array of MemberValue objects.

Returns

Array of actuate.xtabanalyzer.MemberValue.

Example

This example returns the number of members in a member object.

function getMemberCount(members){

  if (members){

    var membersArray[] = members.getMembers( );

    return membersArray.length;

  }

  return null;

}

actuate.xtabanalyzer.MemberValue.getValue

Syntax

string MemberValue.getValue( )

Returns the level value.

Returns

String. The level value.

Example

This example returns the value for the level.

function getMemberValue(members){

  if (members){

    return members.getValue( );

  }

  return null;

}

actuate.xtabanalyzer.MemberValue.setLevelName

Syntax

void MemberValue.setLevelName(string level)

Sets the level name

Parameters

level

String. The name of the level.

Example

This example sets the level name.

function setMemberLevelName(member,lvlName){

  if (member){

    member.setLevelName(lvlName);

  }

}

actuate.xtabanalyzer.MemberValue.setValue

Syntax

void MemberValue.setValue(string level)

Sets the level value

Parameters

level

String. The value for the level.

Example

This example sets the level value.

function setMemberLevelValue(member,lvlValue){

  if (member){

    member.setValue(lvlValue);

  }

}

(c) Copyright Actuate Corporation 2011