AbsAggregate (JADE v4.5.0 API)

java.lang.Object
- jade.content.abs.AbsObjectImpl
- - jade.content.abs.AbsPrimitiveSlotsHolder
  - - jade.content.abs.AbsConcept
    - - jade.content.abs.AbsAggregate

All Implemented Interfaces:

AbsObject, AbsTerm, Concept, Term, java.io.Serializable
```
public class AbsAggregate
extends AbsConcept
```
An abstract descriptor that can hold an aggregate entitiy expression.

Author:

Federico Bergenti - Universita` di Parma, Giovanni Caire - TILAB

See Also:

Serialized Form

Field Summary
- Fields inherited from interface jade.content.abs.AbsObject
  ABS_AGENT_ACTION, ABS_AGGREGATE, ABS_CONCEPT, ABS_CONCEPT_SLOT_FUNCTION, ABS_CONTENT_ELEMENT_LIST, ABS_IRE, ABS_PREDICATE, ABS_PRIMITIVE, ABS_VARIABLE, UNKNOWN

Constructor Summary

Constructors
Constructor and Description

AbsAggregate(java.lang.String typeName)
Construct an Abstract descriptor to hold an aggregate of the proper type (i.e.

Constructors
Constructor and Description
`AbsAggregate(java.lang.String typeName)` Construct an Abstract descriptor to hold an aggregate of the proper type (i.e.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(AbsTerm element)` Adds a new element (that must be a term) to this aggregate.
`void`	`clear()` Clear all the elements in this aggregate.
`boolean`	`contains(AbsTerm element)` Test if a given term is contained in this aggregate.
`protected void`	`dump(int indent, java.io.PrintStream ps)`
`AbsTerm`	`get(int i)` Retrieves the `i`-th element in this aggregate.
`AbsObject`	`getAbsObject(java.lang.String name)` Overrides this method to check that name is of the form Codec.UNNAMEDPERFIX+index
`int`	`getAbsType()`
`int`	`getCount()` Overrides method in superclass
`AbsTerm`	`getElementTemplate()` Get the abstract template of aggregate element
`java.lang.String[]`	`getNames()` Overrides method in superclass
`int`	`indexOf(AbsTerm element)` Returns the position of an element within this aggregate.
`boolean`	`isEmpty()` Test if the aggregate is empty.
`boolean`	`isGrounded()` Tests if this AbsAggregate is grounded, i.e., if no one of its elements is associated with a variable
`Iterator`	`iterator()`
`boolean`	`remove(AbsTerm element)` Removes an element from this aggregate.
`AbsTerm`	`remove(int index)` Removes the element at the given position from this aggregate.
`void`	`set(java.lang.String name, AbsTerm value)` Overrides this method to check that name is of the form Codec.UNNAMEDPERFIX+index
`void`	`setElementTemplate(AbsTerm elementTemplate)` Set the abstract template of aggregate element
`int`	`size()` Retrieves the number of elements in this aggregate.
`AbsTerm[]`	`toArray()` Retrieve all elements in this aggregate in the form of an array.
`java.lang.String`	`toString()` This method is here just for debugging.

Methods inherited from class jade.content.abs.AbsConcept
getAbsTerm, getJavaClass

Methods inherited from class jade.content.abs.AbsPrimitiveSlotsHolder
getBoolean, getByteSequence, getDate, getDouble, getFloat, getInteger, getLong, getString, set, set, set, set, set, set, set, set, set

Methods inherited from class jade.content.abs.AbsObjectImpl
equals, getTypeName, hashCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jade.content.abs.AbsObject
getTypeName

- Constructor Detail
  - AbsAggregate
```
public AbsAggregate(java.lang.String typeName)
```
    Construct an Abstract descriptor to hold an aggregate of the proper type (i.e. SET, SEQUENCE...).
    
    Parameters:
    
    typeName - The name of the type of the aggregate held by this abstract descriptor.
- Method Detail
  - add
```
public void add(AbsTerm element)
```
    Adds a new element (that must be a term) to this aggregate.
    
    Parameters:
    
    element - The element to add.
  - size
```
public int size()
```
    Retrieves the number of elements in this aggregate.
    
    Returns:
    
    The number of elements.
  - get
```
public AbsTerm get(int i)
```
    Retrieves the i-th element in this aggregate.
    
    Parameters:
    
    i - The index of the element to retrieve.
    
    Returns:
    
    The element.
  - iterator
```
public Iterator iterator()
```
    Returns:
    
    An Iterator over the elements of this aggregate.
  - clear
```
public void clear()
```
    Clear all the elements in this aggregate.
  - contains
```
public boolean contains(AbsTerm element)
```
    Test if a given term is contained in this aggregate.
    
    Returns:
    
    true if the given term is contained in this aggregate.
  - indexOf
```
public int indexOf(AbsTerm element)
```
    Returns the position of an element within this aggregate.
    
    Returns:
    
    The position of an element within this aggregate.
  - remove
```
public AbsTerm remove(int index)
```
    Removes the element at the given position from this aggregate.
    
    Returns:
    
    The removed element.
  - remove
```
public boolean remove(AbsTerm element)
```
    Removes an element from this aggregate.
    
    Returns:
    
    The removed element.
  - isEmpty
```
public boolean isEmpty()
```
    Test if the aggregate is empty.
    
    Returns:
    
    true if this aggregate does not contain any element.
  - toArray
```
public AbsTerm[] toArray()
```
    Retrieve all elements in this aggregate in the form of an array.
    
    Returns:
    
    An array containing all elements in this aggregate.
  - set
```
public void set(java.lang.String name,
                AbsTerm value)
```
    Overrides this method to check that name is of the form Codec.UNNAMEDPERFIX+index
    
    Overrides:
    
    set in class AbsConcept
    
    Parameters:
    
    name - The name of the attribute to be set.
    
    value - The new value of the attribute.
    
    Throws:
    
    java.lang.IllegalArgumentException - if name is not of the form Codec.UNNAMEDPERFIX+index
  - dump
```
protected void dump(int indent,
                    java.io.PrintStream ps)
```
  - getAbsObject
```
public AbsObject getAbsObject(java.lang.String name)
```
    Overrides this method to check that name is of the form Codec.UNNAMEDPERFIX+index
    
    Specified by:
    
    getAbsObject in interface AbsObject
    
    Overrides:
    
    getAbsObject in class AbsObjectImpl
    
    Parameters:
    
    name - The name of the attribute.
    
    Returns:
    
    value The value of the attribute.
    
    See Also:
    
    AbsObject.getAbsObject(String)
  - getNames
```
public java.lang.String[] getNames()
```
    Overrides method in superclass
    
    Specified by:
    
    getNames in interface AbsObject
    
    Overrides:
    
    getNames in class AbsObjectImpl
    
    Returns:
    
    the name of all attributes.
    
    See Also:
    
    AbsObject.getNames()
  - isGrounded
```
public boolean isGrounded()
```
    Tests if this AbsAggregate is grounded, i.e., if no one of its elements is associated with a variable
    
    Specified by:
    
    isGrounded in interface AbsObject
    
    Overrides:
    
    isGrounded in class AbsObjectImpl
    
    Returns:
    
    true if the object is grounded.
    
    See Also:
    
    AbsObject.isGrounded()
  - getCount
```
public int getCount()
```
    Overrides method in superclass
    
    Specified by:
    
    getCount in interface AbsObject
    
    Overrides:
    
    getCount in class AbsObjectImpl
    
    Returns:
    
    the number of attributes.
    
    See Also:
    
    AbsObject.getCount()
  - getAbsType
```
public int getAbsType()
```
    Specified by:
    
    getAbsType in interface AbsObject
    
    Overrides:
    
    getAbsType in class AbsConcept
  - getElementTemplate
```
public AbsTerm getElementTemplate()
```
    Get the abstract template of aggregate element
  - setElementTemplate
```
public void setElementTemplate(AbsTerm elementTemplate)
```
    Set the abstract template of aggregate element
  - toString
```
public java.lang.String toString()
```
    This method is here just for debugging. Notice that it is highly innefficient. The method StringCodec.encode() should be used instead.
    
    Overrides:
    
    toString in class AbsObjectImpl
    
    See Also:
    
    StringCodec.encode(AbsContentElement content)

Class AbsAggregate

Field Summary

Fields inherited from interface jade.content.abs.AbsObject

Constructor Summary

Method Summary

Methods inherited from class jade.content.abs.AbsConcept

Methods inherited from class jade.content.abs.AbsPrimitiveSlotsHolder

Methods inherited from class jade.content.abs.AbsObjectImpl

Methods inherited from class java.lang.Object

Methods inherited from interface jade.content.abs.AbsObject

Constructor Detail

AbsAggregate

Method Detail

add

size

get

iterator

clear

contains

indexOf

remove

remove

isEmpty

toArray

set

dump

getAbsObject

getNames

isGrounded

getCount

getAbsType

getElementTemplate

setElementTemplate

toString