Package astra.lang

Class Prelude

java.lang.Object

astra.core.Module

astra.lang.Prelude

public class Prelude
extends Module

This API provides support for manipulating ASTRA Lists.

Author:

Rem Collier

Nested Class Summary

Nested classes/interfaces inherited from class astra.core.Module

Module.ACTION, Module.EVENT, Module.FORMULA, Module.SENSOR, Module.SUPPRESS_NOTIFICATIONS, Module.TERM

Field Summary

Fields inherited from class astra.core.Module

agent

Constructor Summary

Constructors

Constructor	Description
Prelude()

Method Summary

Modifier and Type	Method	Description
boolean	add(ListTerm list, Boolean object)
boolean	add(ListTerm list, Character object)
boolean	add(ListTerm list, Double object)
boolean	add(ListTerm list, Float object)
boolean	add(ListTerm list, Integer object)
boolean	add(ListTerm list, Long object)
boolean	add(ListTerm list, Object object)	Action that adds any object to a list
boolean	add(ListTerm list, String object)
boolean	addAt(ListTerm list, int index, Boolean object)
boolean	addAt(ListTerm list, int index, Character object)
boolean	addAt(ListTerm list, int index, Double object)
boolean	addAt(ListTerm list, int index, Float object)
boolean	addAt(ListTerm list, int index, Integer object)
boolean	addAt(ListTerm list, int index, Long object)
boolean	addAt(ListTerm list, int index, Object object)	Action that adds any object to a list at a given index.
boolean	addAt(ListTerm list, int index, String object)
boolean	booleanValueFor(ListTerm list, String funct)
boolean	booleanValueFor(ListTerm list, String functor, int index)
char	charValueFor(ListTerm list, String funct)
char	charValueFor(ListTerm list, String functor, int index)
Formula	contains(ListTerm list, char value)
Formula	contains(ListTerm list, double value)
Formula	contains(ListTerm list, float value)
Formula	contains(ListTerm list, int value)
Formula	contains(ListTerm list, long value)
Formula	contains(ListTerm list, String value)
double	doubleValueFor(ListTerm list, String funct)
double	doubleValueFor(ListTerm list, String functor, int index)
float	floatValueFor(ListTerm list, String funct)
float	floatValueFor(ListTerm list, String functor, int index)
List	fromASTRAList(ListTerm list)	Term that converts the ASTRA list to a standard list of Java objects.
double	headAsDouble(ListTerm list)
float	headAsFloat(ListTerm list)
int	headAsInt(ListTerm list)
long	headAsLong(ListTerm list)
String	headAsString(ListTerm list)
int	intValueFor(ListTerm list, String funct)
int	intValueFor(ListTerm list, String functor, int index)
Formula	isEmpty(ListTerm list)	Formula that returns true if the list is empty, false otherwise
long	longValueFor(ListTerm list, String funct)
long	longValueFor(ListTerm list, String functor, int index)
Object	objectValueFor(ListTerm list, String funct)
Object	objectValueFor(ListTerm list, String functor, int index)
boolean	remove(ListTerm list, int index)	Action that removes an object from a list at a given index.
boolean	reverse(ListTerm list)	Term that reverses the order of the values stored in the list.
boolean	shuffle(ListTerm list)
int	size(ListTerm list)	Term that returns the size of the list.
boolean	sort_asc(ListTerm list)	Term that sorts the list in ascending order.
boolean	sort_desc(ListTerm list)	Term that sorts the list in descending order.
String	stringValueFor(ListTerm list, String funct)
String	stringValueFor(ListTerm list, String functor, int index)
boolean	swap(ListTerm list, int i, int j)	Term that swaps the value at index i with the value at index j in the list.
ListTerm	tail(ListTerm list)
ListTerm	toASTRAList(List list)	Term that converts any Java list (anything that implements the List interface) into an ASTRA list.
Object[]	toObjectArray(ListTerm list)	Term that converts a list to an object array.
Boolean	valueAsBoolean(ListTerm list, int index)	Term that returns the value at the given index cast as a boolean.
double	valueAsDouble(ListTerm list, int index)	Term that returns the value at the given index cast as an double.
float	valueAsFloat(ListTerm list, int index)	Term that returns the value at the given index cast as an float.
Funct	valueAsFunct(ListTerm list, int index)	Term that returns the value at the given index cast as an long.
int	valueAsInt(ListTerm list, int index)	Term that returns the value at the given index cast as an int.
ListTerm	valueAsList(ListTerm list, int index)	Term that returns the value at the given index cast as a list.
long	valueAsLong(ListTerm list, int index)	Term that returns the value at the given index cast as an long.
String	valueAsString(ListTerm list, int index)	Term that returns the value at the given index cast as an string.

Methods inherited from class astra.core.Module

inline, setAgent

Methods inherited from class java.lang.Object

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

Constructor Detail

Prelude

public Prelude()

Method Detail

headAsString

public String headAsString(ListTerm list)

headAsInt

public int headAsInt(ListTerm list)

headAsLong

public long headAsLong(ListTerm list)

headAsFloat

public float headAsFloat(ListTerm list)

headAsDouble

public double headAsDouble(ListTerm list)

tail

public ListTerm tail(ListTerm list)

add

public boolean add(ListTerm list,
                   Object object)

Action that adds any object to a list

Parameters:

list - the list that is to be modified

object - the object that is to be added to the list

Returns:

true if the action succeeds, false otherwise

add

public boolean add(ListTerm list,
                   Integer object)

add

public boolean add(ListTerm list,
                   Long object)

add

public boolean add(ListTerm list,
                   Float object)

add

public boolean add(ListTerm list,
                   Double object)

add

public boolean add(ListTerm list,
                   Character object)

add

public boolean add(ListTerm list,
                   String object)

add

public boolean add(ListTerm list,
                   Boolean object)

addAt

public boolean addAt(ListTerm list,
                     int index,
                     Object object)

Action that adds any object to a list at a given index.

Parameters:

list - the list that is to be modified

index - the index at which the object is to be added

object - the object that is to be added to the list

Returns:

true if the item is added, false otherwise

addAt

public boolean addAt(ListTerm list,
                     int index,
                     Integer object)

addAt

public boolean addAt(ListTerm list,
                     int index,
                     Long object)

addAt

public boolean addAt(ListTerm list,
                     int index,
                     Float object)

addAt

public boolean addAt(ListTerm list,
                     int index,
                     Double object)

addAt

public boolean addAt(ListTerm list,
                     int index,
                     Character object)

addAt

public boolean addAt(ListTerm list,
                     int index,
                     String object)

addAt

public boolean addAt(ListTerm list,
                     int index,
                     Boolean object)

remove

public boolean remove(ListTerm list,
                      int index)

Action that removes an object from a list at a given index.

Parameters:

list - the list to be modified

index - the index of the object to be removed

Returns:

true if the item is removed, false otherwise

size

public int size(ListTerm list)

Term that returns the size of the list.

Parameters:

list - the list whose size is needed.

Returns:

the size of the list

isEmpty

public Formula isEmpty(ListTerm list)

Formula that returns true if the list is empty, false otherwise

Parameters:

list - the list whose state is to be checked

Returns:

The formula TRUE if the list is empty, or the formula FALSE is the list is not empty

contains

public Formula contains(ListTerm list,
                        String value)

contains

public Formula contains(ListTerm list,
                        int value)

contains

public Formula contains(ListTerm list,
                        long value)

contains

public Formula contains(ListTerm list,
                        float value)

contains

public Formula contains(ListTerm list,
                        double value)

contains

public Formula contains(ListTerm list,
                        char value)

stringValueFor

public String stringValueFor(ListTerm list,
                             String funct)

stringValueFor

public String stringValueFor(ListTerm list,
                             String functor,
                             int index)

intValueFor

public int intValueFor(ListTerm list,
                       String funct)

intValueFor

public int intValueFor(ListTerm list,
                       String functor,
                       int index)

longValueFor

public long longValueFor(ListTerm list,
                         String funct)

longValueFor

public long longValueFor(ListTerm list,
                         String functor,
                         int index)

charValueFor

public char charValueFor(ListTerm list,
                         String funct)

charValueFor

public char charValueFor(ListTerm list,
                         String functor,
                         int index)

booleanValueFor

public boolean booleanValueFor(ListTerm list,
                               String funct)

booleanValueFor

public boolean booleanValueFor(ListTerm list,
                               String functor,
                               int index)

objectValueFor

public Object objectValueFor(ListTerm list,
                             String funct)

objectValueFor

public Object objectValueFor(ListTerm list,
                             String functor,
                             int index)

floatValueFor

public float floatValueFor(ListTerm list,
                           String funct)

floatValueFor

public float floatValueFor(ListTerm list,
                           String functor,
                           int index)

doubleValueFor

public double doubleValueFor(ListTerm list,
                             String funct)

doubleValueFor

public double doubleValueFor(ListTerm list,
                             String functor,
                             int index)

shuffle

public boolean shuffle(ListTerm list)

valueAsInt

public int valueAsInt(ListTerm list,
                      int index)

Term that returns the value at the given index cast as an int.

Parameters:

list - the list containing the value

index - the index of the value in the list

Returns:

the value at the given index in the list

valueAsLong

public long valueAsLong(ListTerm list,
                        int index)

Term that returns the value at the given index cast as an long.

Parameters:

list - the list containing the value

index - the index of the value in the list

Returns:

the value at the given index in the list

valueAsFunct

public Funct valueAsFunct(ListTerm list,
                          int index)

Term that returns the value at the given index cast as an long.

Parameters:

list - the list containing the value

index - the index of the value in the list

Returns:

the value at the given index in the list

valueAsDouble

public double valueAsDouble(ListTerm list,
                            int index)

Term that returns the value at the given index cast as an double.

Parameters:

list - the list containing the value

index - the index of the value in the list

Returns:

the value at the given index in the list

valueAsFloat

public float valueAsFloat(ListTerm list,
                          int index)

Term that returns the value at the given index cast as an float.

Parameters:

list - the list containing the value

index - the index of the value in the list

Returns:

the value at the given index in the list

valueAsList

public ListTerm valueAsList(ListTerm list,
                            int index)

Term that returns the value at the given index cast as a list.

Parameters:

list - the list containing the value

index - the index of the value in the list

Returns:

the value at the given index in the list

valueAsString

public String valueAsString(ListTerm list,
                            int index)

Term that returns the value at the given index cast as an string.

Parameters:

list - the list containing the value

index - the index of the value in the list

Returns:

the value at the given index in the list

valueAsBoolean

public Boolean valueAsBoolean(ListTerm list,
                              int index)

Term that returns the value at the given index cast as a boolean.

Parameters:

list - the list containing the value

index - the index of the value in the list

Returns:

the value at the given index in the list

sort_asc

public boolean sort_asc(ListTerm list)

Term that sorts the list in ascending order. This method assumes that the values stored in the list are comparable.

Parameters:

list - the list to be sorted

Returns:

true if the action succeeds, false otherwise

sort_desc

public boolean sort_desc(ListTerm list)

Term that sorts the list in descending order. This method assumes that the values stored in the list are comparable.

Parameters:

list - the list to be sorted

Returns:

true if the action succeeds, false otherwise

swap

public boolean swap(ListTerm list,
                    int i,
                    int j)

Term that swaps the value at index i with the value at index j in the list.

Parameters:

list - the list to be modified

i - the index of the first value

j - the index of the second value

Returns:

true if the action succeeded, false otherwise

reverse

public boolean reverse(ListTerm list)

Term that reverses the order of the values stored in the list.

Parameters:

list - the source list

Returns:

true if the action succeeded, false otherwise

fromASTRAList

public List fromASTRAList(ListTerm list)

Term that converts the ASTRA list to a standard list of Java objects. This assumes that the ASTRA list contains only primitives...

Parameters:

list - the source list

Returns:

the list of values

toASTRAList

public ListTerm toASTRAList(List list)

Term that converts any Java list (anything that implements the List interface) into an ASTRA list. Here the contents of the original list are assumed to be primitives or objects and are converted to ASTRA Primitives.

Parameters:

list - the list to be converted

Returns:

an ASTRA list of values

toObjectArray

public Object[] toObjectArray(ListTerm list)

Term that converts a list to an object array.

Parameters:

list - the list

Returns:

an array of objects