org.topbraid.spin.model
Interface Module

All Known Subinterfaces:
Function, Template

public interface Module

Instances of spin:Module (or subclasses thereof).

Author:
Holger Knublauch

Method Summary
 java.util.List<Argument> getArguments(boolean ordered)
          Gets a List of all declared Arguments.
 java.util.Map<java.lang.String,Argument> getArgumentsMap()
          Gets a Map of variable names to Arguments.
 Query getBody()
          Gets the body (if defined).
 java.lang.String getComment()
          Gets the rdfs:comment of this (if any).
 boolean isAbstract()
          Checks if this Module has been declared to be abstract using spin:abstract.
 

Method Detail

getArguments

java.util.List<Argument> getArguments(boolean ordered)
Gets a List of all declared Arguments. If ordered, then the local names of the predicates are used.

Parameters:
ordered - true to get an ordered list back (slower)
Returns:
the (possibly empty) List of Arguments

getArgumentsMap

java.util.Map<java.lang.String,Argument> getArgumentsMap()
Gets a Map of variable names to Arguments.

Returns:
a Map of variable names to Arguments

getBody

Query getBody()
Gets the body (if defined). The result will be type cast into the most specific subclass of Query if possible.

Returns:
the body or null

getComment

java.lang.String getComment()
Gets the rdfs:comment of this (if any).

Returns:
the comment or null

isAbstract

boolean isAbstract()
Checks if this Module has been declared to be abstract using spin:abstract.

Returns:
true if this is abstract