TypedStructureAdapter

java.lang.Object
- net.sf.tweety.logics.commons.syntax.TypedStructureAdapter

All Implemented Interfaces:

java.lang.Comparable<TypedStructureAdapter>, TypedStructure

Direct Known Subclasses:

Functor, Predicate
```
public abstract class TypedStructureAdapter
extends java.lang.Object
implements TypedStructure, java.lang.Comparable<TypedStructureAdapter>
```
The abstract parent for predicates and functors implementing the TypedStructure interface. This class implements their common functionalities.

Author:

Matthias Thimm, Tim Janus

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.List<Sort>`	`arguments` This list constrains the possible arguments of this structure to the given sorts.
`private int`	`arity` the number of arguments for a complete structure
`private java.lang.String`	`name` The name of this structure

Constructor Summary

Constructors
Constructor and Description
`TypedStructureAdapter()` Default-Ctor: Creating empty typed structure
`TypedStructureAdapter(java.lang.String name)` Initializes a structure of arity zero with the given name;
`TypedStructureAdapter(java.lang.String name, int arity)` Initializes a structure with the given name and of the given arity.
`TypedStructureAdapter(java.lang.String name, java.util.List<Sort> arguments)` Initializes a structure with the given name and the given list of argument sorts.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addArgumentType(Sort argType)` Adds the given Sort as argument type to the typed Structure
`abstract TypedStructure`	`clone()` Creates a deep copy of this object
`int`	`compareTo(TypedStructureAdapter o)`
`protected java.util.List<Sort>`	`copyArgumentTypes()`
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<Sort>`	`getArgumentTypes()`
`int`	`getArity()`
`java.lang.String`	`getName()`
`int`	`hashCode()`
`boolean`	`isComplete()`
`boolean`	`isTyped()`
`Sort`	`removeArgumentType(int index)` Removes the argument type at the specified index
`boolean`	`removeArgumentType(Sort argType)` Removes the given Sort from the list of argument types
`void`	`setArity(int arity)` Sets the arity of this structure
`void`	`setName(java.lang.String name)` Changes the name of the Structure
`java.lang.String`	`toString()`

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

- Field Detail
  - name
```
private java.lang.String name
```
    The name of this structure
  - arguments
```
private java.util.List<Sort> arguments
```
    This list constrains the possible arguments of this structure to the given sorts. Therefore the arity of this structure is the size of the list if the structure isComplete().
  - arity
```
private int arity
```
    the number of arguments for a complete structure
- Constructor Detail
  - TypedStructureAdapter
```
public TypedStructureAdapter()
```
    Default-Ctor: Creating empty typed structure
  - TypedStructureAdapter
```
public TypedStructureAdapter(java.lang.String name)
```
    Initializes a structure of arity zero with the given name;
    
    Parameters:
    
    name - the name of the structure
  - TypedStructureAdapter
```
public TypedStructureAdapter(java.lang.String name,
                             int arity)
```
    Initializes a structure with the given name and of the given arity. Every argument gets the sort Sort.THING.
    
    Parameters:
    
    name - the name of the structure
  - TypedStructureAdapter
```
public TypedStructureAdapter(java.lang.String name,
                             java.util.List<Sort> arguments)
```
    Initializes a structure with the given name and the given list of argument sorts.
    
    Parameters:
    
    name - the name of the structure
    
    arguments - the sorts of the arguments
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface TypedStructure
    
    Returns:
    
    the unique name of the structure
  - setName
```
public void setName(java.lang.String name)
```
    Description copied from interface: TypedStructure
    
    Changes the name of the Structure
    
    Specified by:
    
    setName in interface TypedStructure
    
    Parameters:
    
    name - The new name of the structure
  - getArity
```
public int getArity()
```
    Specified by:
    
    getArity in interface TypedStructure
    
    Returns:
    
    the arity of this structure
  - setArity
```
public void setArity(int arity)
```
    Description copied from interface: TypedStructure
    
    Sets the arity of this structure
    
    Specified by:
    
    setArity in interface TypedStructure
    
    Parameters:
    
    arity - the new arity
  - getArgumentTypes
```
public java.util.List<Sort> getArgumentTypes()
```
    Specified by:
    
    getArgumentTypes in interface TypedStructure
    
    Returns:
    
    An unmodifiable list which length equals the arity of the predicate if the structure isComplete().
  - addArgumentType
```
public void addArgumentType(Sort argType)
```
    Description copied from interface: TypedStructure
    
    Adds the given Sort as argument type to the typed Structure
    
    Specified by:
    
    addArgumentType in interface TypedStructure
    
    Parameters:
    
    argType - The Sort descibing the argument type
  - removeArgumentType
```
public Sort removeArgumentType(int index)
```
    Description copied from interface: TypedStructure
    
    Removes the argument type at the specified index
    
    Specified by:
    
    removeArgumentType in interface TypedStructure
    
    Parameters:
    
    index - The index
    
    Returns:
    
    A reference to the sort that has been remove or null if no sort has been removed.
  - removeArgumentType
```
public boolean removeArgumentType(Sort argType)
```
    Description copied from interface: TypedStructure
    
    Removes the given Sort from the list of argument types
    
    Specified by:
    
    removeArgumentType in interface TypedStructure
    
    Parameters:
    
    argType - The Sort which is removed
    
    Returns:
    
    true if the Sort exists in the list of argument types and is successfully removed, false otherwise.
  - isTyped
```
public boolean isTyped()
```
    Specified by:
    
    isTyped in interface TypedStructure
    
    Returns:
    
    true if at least one sort for an argument is not "Thing".
  - isComplete
```
public boolean isComplete()
```
    Specified by:
    
    isComplete in interface TypedStructure
    
    Returns:
    
    true if the arity of this structure matches the length of it's arguments, false if the arity is bigger than the length of it's arguments.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - copyArgumentTypes
```
protected java.util.List<Sort> copyArgumentTypes()
```
  - clone
```
public abstract TypedStructure clone()
```
    Description copied from interface: TypedStructure
    
    Creates a deep copy of this object
    
    Specified by:
    
    clone in interface TypedStructure
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    A deep copy of this object
  - compareTo
```
public int compareTo(TypedStructureAdapter o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<TypedStructureAdapter>

Class TypedStructureAdapter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

arguments

arity

Constructor Detail

TypedStructureAdapter

TypedStructureAdapter

TypedStructureAdapter

TypedStructureAdapter

Method Detail

getName

setName

getArity

setArity

getArgumentTypes

addArgumentType

removeArgumentType

removeArgumentType

isTyped

isComplete

toString

hashCode

equals

copyArgumentTypes

clone

compareTo