com.madara.containers

Class Map

java.lang.Object

com.madara.MadaraJNI

com.madara.containers.BaseContainer

com.madara.containers.Map

public class Map
extends BaseContainer

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear(boolean clear_variables) 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 Map	fromPointer(long cptr) Creates a java object instance from a C/C++ pointer
static Map	fromPointer(long cptr, boolean shouldManage) Creates a java object instance from a C/C++ pointer
KnowledgeRecord	get(java.lang.String key) Gets the value
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 the current keys in the map
void	modify() Mark the map as modified.
void	modify(java.lang.String key) Mark an element as modified.
void	set(java.lang.String key, double value) Sets the value
void	set(java.lang.String key, KnowledgeRecord value) Sets the value
void	set(java.lang.String key, long value) Sets the value
void	set(java.lang.String key, java.lang.String value) Sets the 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
void	sync() Syncs the map to the underlying knowledge base.
KnowledgeRecord	toRecord(java.lang.String key) 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

Map

public Map()

Default constructor

Map

public Map(Map input)

Copy constructor

Parameters:

input - instance to copy

Method Detail

fromPointer

public static Map 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 Map 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

get

public KnowledgeRecord get(java.lang.String key)

Gets the value

Parameters:

key - the location in the map

Returns:

current value

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

keys

public java.lang.String[] keys()

Gets the current keys in the map

Returns:

name of the variable within the context

sync

public void sync()

Syncs the map to the underlying knowledge base. Call this method if you believe the map's keys may have changed in the knowledge base.

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

modify

public void modify(java.lang.String key)

Mark an element as modified. The element retains the same value but will resend the value as if it had been modified.

Parameters:

key - the element key

clear

public void clear(boolean clear_variables)

Clears the variables in the map

Parameters:

clear_variables - if true, clear the variables from the knowledge base as well as 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 key,
                java.lang.String value)

Sets the value

Parameters:

key - the location in the map

value - new value

set

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

Sets the value

Parameters:

key - the location in the map

value - new value

set

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

Sets the value

Parameters:

key - the location in the map

value - new value

set

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

Sets the value

Parameters:

key - the location in the 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(java.lang.String key)

Returns a value at the specified key

Parameters:

key - the location in the map

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