com.madara.containers

Class FlexMap

java.lang.Object

com.madara.MadaraJNI

com.madara.containers.BaseContainer

com.madara.containers.FlexMap

public class FlexMap
extends BaseContainer

A facade for a map of variable names to values within a knowledge base

Constructor Summary

Constructors

Constructor and Description
FlexMap() Default constructor
FlexMap(FlexMap input) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the variables in the map
void	erase(java.lang.String key) Erases a variable located at key in the map.
protected void	finalize() Cleans up underlying C resources
void	free() Deletes the C instantiation.
static FlexMap	fromPointer(long cptr) Creates a java object instance from a C/C++ pointer
static FlexMap	fromPointer(long cptr, boolean shouldManage) Creates a java object instance from a C/C++ pointer
FlexMap	get(int index) Creates a FlexMap at the indexed location
FlexMap	get(java.lang.String key) Creates a FlexMap at the keyed location
java.lang.String	getDelimiter() Gets the delimiter that separates the name of the map with its elements
java.lang.String	getName() Gets the name of the variable
boolean	isFalse() Returns true if the container evaluates to false
boolean	isTrue() Returns true if the container evaluates to true
java.lang.String[]	keys() Gets all keys in the map
java.lang.String[]	keys(boolean firstLevel) Gets keys in the map, with option to get only first level keys
void	modify() Mark the map as modified.
void	set(double value) Sets the location to a double
void	set(long value) Sets the location to an integer value
void	set(java.lang.String value) Sets the location to a string
void	set(java.lang.String key, KnowledgeRecord value) Sets the location to a KnowledgeRecord value
void	setDelimiter(java.lang.String delimiter) Sets the delimiter that separates the name of the map with its elements
void	setName(KnowledgeBase kb, java.lang.String name) Sets the name and knowledge base being referred to
void	setName(Variables vars, java.lang.String name) Sets the name and knowledge base being referred to
void	setSettings(UpdateSettings settings) Sets the settings for updating variables in the Knowledge Base
Map	toMapContainer() Creates a Map container from the current location.
KnowledgeRecord	toRecord() Returns a value at the specified key

Methods inherited from class com.madara.containers.BaseContainer

modifyIfFalse, modifyIfTrue

Methods inherited from class com.madara.MadaraJNI

getCPtr, setCPtr, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FlexMap

public FlexMap()

Default constructor

FlexMap

public FlexMap(FlexMap input)

Copy constructor

Parameters:

input - instance to copy

Method Detail

fromPointer

public static FlexMap fromPointer(long cptr)

Creates a java object instance from a C/C++ pointer

Parameters:

cptr - C pointer to the object

Returns:

a new java instance of the underlying pointer

fromPointer

public static FlexMap fromPointer(long cptr,
                                  boolean shouldManage)

Creates a java object instance from a C/C++ pointer

Parameters:

cptr - C pointer to the object

shouldManage - if true, manage the pointer

Returns:

a new java instance of the underlying pointer

keys

public java.lang.String[] keys()

Gets all keys in the map

Returns:

all keys in the map

keys

public java.lang.String[] keys(boolean firstLevel)

Gets keys in the map, with option to get only first level keys

Parameters:

firstLevel - if true, only return the immediate subkeys and not full key names

Returns:

the keys in the map

get

public FlexMap get(java.lang.String key)

Creates a FlexMap at the keyed location

Parameters:

key - the next level of the FlexMap

Returns:

FlexMap pointing to the keyed location

get

public FlexMap get(int index)

Creates a FlexMap at the indexed location

Parameters:

index - an index into the FlexMap

Returns:

FlexMap pointing to the indexed location

getName

public java.lang.String getName()

Gets the name of the variable

Returns:

name of the variable within the context

getDelimiter

public java.lang.String getDelimiter()

Gets the delimiter that separates the name of the map with its elements

Returns:

the delimiter that separates map name with elements

setDelimiter

public void setDelimiter(java.lang.String delimiter)

Sets the delimiter that separates the name of the map with its elements

Parameters:

delimiter - the separator between the map and elements

modify

public void modify()

Mark the map as modified. The maps retains the same values but will resend all values as if they had been modified.

isTrue

public boolean isTrue()

Returns true if the container evaluates to true

Returns:

true if container has all true values

isFalse

public boolean isFalse()

Returns true if the container evaluates to false

Returns:

true if container has any false values or is uninitialized

clear

public void clear()

Clears the variables in the map

erase

public void erase(java.lang.String key)

Erases a variable located at key in the map. This also deletes the variable from the knowledge base.

Parameters:

key - the element key

set

public void set(java.lang.String value)

Sets the location to a string

Parameters:

value - new value

set

public void set(double value)

Sets the location to a double

Parameters:

value - new value

set

public void set(long value)

Sets the location to an integer value

Parameters:

value - new value

set

public void set(java.lang.String key,
                KnowledgeRecord value)

Sets the location to a KnowledgeRecord value

Parameters:

key - the location within the virtual map

value - new value

setName

public void setName(KnowledgeBase kb,
                    java.lang.String name)

Sets the name and knowledge base being referred to

Parameters:

kb - the knowledge base that contains the name

name - the variable name

setName

public void setName(Variables vars,
                    java.lang.String name)

Sets the name and knowledge base being referred to

Parameters:

vars - the variables facade that contains the name

name - the variable name

setSettings

public void setSettings(UpdateSettings settings)

Sets the settings for updating variables in the Knowledge Base

Parameters:

settings - the settings to use for updating the Knowledge Base

toRecord

public KnowledgeRecord toRecord()

Returns a value at the specified key

Returns:

the value at the index as a knowledge record

toMapContainer

public Map toMapContainer()

Creates a Map container from the current location. Maps maintain lists of keys and are more appropriate for frequent accesses of sub keys (i.e., they are better performance, while FlexMap is more flexible).

Returns:

the value at the index as a knowledge record

free

public void free()

Deletes the C instantiation. To prevent memory leaks, this must be called before an instance gets garbage collected

finalize

protected void finalize()
                 throws java.lang.Throwable

Cleans up underlying C resources

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - necessary for override but unused