Package ai.libs.jaicore.components.model

Class Interface

java.lang.Object

ai.libs.jaicore.components.model.Interface

All Implemented Interfaces:

IRequiredInterfaceDefinition, java.io.Serializable

public class Interface
extends java.lang.Object
implements IRequiredInterfaceDefinition, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Interface(java.lang.String id, java.lang.String name, java.lang.Boolean optional, java.lang.Boolean uniqueComponents, java.lang.Boolean ordered, java.lang.Integer min, java.lang.Integer max)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getId()
int	getMax()
int	getMin()	The minimum can be greater than 0 even if the interface is optional.
java.lang.String	getName()
int	hashCode()
boolean	isOptional()
boolean	isOrdered()
boolean	isUniqueComponents()

Methods inherited from class java.lang.Object

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

Constructor Detail

Interface

public Interface(java.lang.String id,
                 java.lang.String name,
                 java.lang.Boolean optional,
                 java.lang.Boolean uniqueComponents,
                 java.lang.Boolean ordered,
                 java.lang.Integer min,
                 java.lang.Integer max)

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface IRequiredInterfaceDefinition

Returns:

the id of this interface within the component that defines it (can be interpreted as the *role* name of this interface in the component)

getName

public java.lang.String getName()

Specified by:

getName in interface IRequiredInterfaceDefinition

Returns:

the name of the interface

getMin

public int getMin()

Description copied from interface: IRequiredInterfaceDefinition

The minimum can be greater than 0 even if the interface is optional. In that case, the semantic is: Either the interface is not satisfied or it has at least this number of realizations.

Specified by:

getMin in interface IRequiredInterfaceDefinition

Returns:

minimum number of required realizations if satisfied at all

getMax

public int getMax()

Specified by:

getMax in interface IRequiredInterfaceDefinition

Returns:

maximum number of allowed realizations

isUniqueComponents

public boolean isUniqueComponents()

Specified by:

isUniqueComponents in interface IRequiredInterfaceDefinition

Returns:

Tells whether there is a limitation that each component must be contained at most once

isOrdered

public boolean isOrdered()

Specified by:

isOrdered in interface IRequiredInterfaceDefinition

Returns:

Tells whether the order of realizations of this interface is relevant or not.

isOptional

public boolean isOptional()

Specified by:

isOptional in interface IRequiredInterfaceDefinition

Returns:

Tells whether the required interface is optional

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