Package | Description |
---|---|
com.spss.psapi |
This provides general classes used by other parts of the API.
|
com.spss.psapi.admin |
This provides functionality to support server administration activities.
|
com.spss.psapi.as |
This provides support for accessing the IBM SPSS Analytic Server.
|
com.spss.psapi.content |
This provides classes used for accessing content generated during stream execution.
|
com.spss.psapi.core |
This provides the base objects used by other parts of the API.
|
com.spss.psapi.data |
This provides support for metadata such as the names, values and types of data.
|
com.spss.psapi.expr |
This provides support for parsing CLEM expressions.
|
com.spss.psapi.extensions |
This provides definitions associated with the Modeler Extensions Framework (CLEF).
|
com.spss.psapi.extensions.common |
This provides definitions that are used to manage streams, documents and models in scripting, and for extensions using the CLEF Java API.
|
com.spss.psapi.extensions.common.spi | |
com.spss.psapi.extensions.common.spi2 |
This defines SPI (Service Provider Interface) definitions that are implemented by
an extension.
|
com.spss.psapi.extensions.ui |
This provides UI-specific definitions that are exposed to CLEF implementors using the CLEF Java API.
|
com.spss.psapi.extensions.ui.spi | |
com.spss.psapi.interaction |
This provides classes used for interactive modeling.
|
com.spss.psapi.model |
This provides support for accessing information about data mining models.
|
com.spss.psapi.resource |
This provides access to server-side resources such as the server file system and database connections.
|
com.spss.psapi.runtime |
This provides support for the handling of runtime execution engines.
|
com.spss.psapi.runtime.spi | |
com.spss.psapi.session |
This provides support for the construction and use of data mining sessions.
|
com.spss.psapi.task |
This provides objects that create and represent data mining tasks.
|
com.spss.psapi.transform |
This provides objects that perform data processing and model building.
|
Modifier and Type | Class and Description |
---|---|
class |
Enum
This class provides the basis for all enumerated classes in the Modeler API.
|
class |
PredictiveServerException
A generic Modeler exception.
|
class |
PredictiveServerRuntimeException
A generic Modeler runtime exception.
|
class |
VersionInfo
Default Modeler API version information.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ServerActivitySnapshot
Interface allowing access to information on server activity (for example, running processes)
|
class |
ServerAdministrationException
An exception thrown when an administration activity fails.
|
interface |
ServerConfiguration
Interface allowing read/write access to the set of configuration options provided by a remote server
|
interface |
ServerSessionDetails
Interface allowing basic information on a connected server session to be obtained
|
Modifier and Type | Class and Description |
---|---|
class |
AnalyticServerException |
interface |
AslCompiler
An interface that supports ASL generation.
|
class |
AslProjectLockingException |
class |
AslUnknownProjectException |
interface |
ClientEmbeddedASDelegate |
interface |
ContainerManager
Defines a container manager that provides container-related services.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ColumnStatsContentModel
An interface that provides a mechanism for accessing column/univariate
statistics from nodes which can produce them.
|
interface |
ContentModel
An interface that provides a mechanism for accessing the content of a
ContentContainer in a structured way. |
interface |
JSONContentModel
An interface that provides a mechanism for accessing the JSON content of a
ContentContainer . |
interface |
PairwiseStatsContentModel
An interface that provides a mechanism for accessing correlations between
columns.
|
class |
StatisticType
Defines the statistics that can be computed either for a single column or
for combinations of columns/column values.
|
interface |
TableContentModel
An interface that provides a mechanism for accessing the tabular content of a
ContentContainer . |
interface |
XMLContentModel
An interface that provides a mechanism for accessing the XML content of a
ContentContainer . |
Modifier and Type | Class and Description |
---|---|
class |
AEConnectionDescriptor |
interface |
ApplicationData
Some features of the Modeler API include information such as the name and version of the application
that built them.
|
interface |
ASCredentialDescriptor
This defines the credentials to log into the Analytic Server.
|
interface |
ConnectedServerInfo |
interface |
ConnectionDetail |
interface |
ConnectionDetailFilter |
interface |
ConnectionDetailView |
interface |
ContentContainer
Defines the functionality associated with a content container.
|
interface |
ContentContainerFactory
Creates instances of
ContentContainer . |
interface |
ContentContainerProvider
An interface that provides the basic mechanism for accessing
and updating generated objects.
|
class |
ContentFormat
Enumerates the valid content formats for content containers.
|
interface |
ContentProvider
Stores and retrieves content for an application.
|
interface |
CredentialDescriptor
This defines the credentials to log into DataBase.
|
interface |
DocumentContainer
Defines the functionality associated with document containers.
|
class |
FileFormat
This class defines constants for the different file formats supported
by objects in the Modeler API.
|
class |
IncompatibleServerException
An exception thrown while attempting to connect to an incompatible server version.
|
class |
InvalidPropertyException
An exception thrown when an invalid property is accessed or an invalid value
is supplied for a property.
|
interface |
ModelContainer
Defines the functionality associated with model containers.
|
class |
ModelFieldRole
This class enumerates the valid model output roles.
|
class |
ObjectCreationException
An exception thrown when an instance of an object cannot be created.
|
class |
ObjectLockedException
An exception thrown when an attempt is made to lock or modify an object that is
already locked.
|
class |
OwnerException
An exception thrown when an object owner requires an owned object.
|
interface |
ParameterDefinition
Describes a parameter which affects the behaviour of some Modeler API objects.
|
interface |
ParameterProvider
Identifies objects that contain parameters.
|
class |
ParameterStorage
This class enumerates the valid storage types for columns in a
DataModel
or parameters. |
class |
ParameterType
This class enumerates the valid types of parameter support by a
ParameterProvider . |
interface |
PropertiedObject
This encapsulates the functionality of objects that contain settable properties.
|
class |
Property
This defines constants corresponding to the property names of all
PropertiedObject objects. |
interface |
PropertyFactory
This provides convenience methods for constructing and decomposing
structured property values.
|
class |
PropertyType
This class enumerates the valid types for Property values.
|
interface |
RepositoryConnectionDescriptor
Defines the basic data elements required to connect to a content repository.
|
interface |
RepositoryConnectionDescriptor2
Extends the repository connection details for applications which are aware of PASW platform services.
|
interface |
RepositoryConnectionDescriptor3 |
interface |
RowSetContainer
Defines the functionality associated with data set containers.
|
interface |
ServerConnectionDescriptor
Defines the basic data elements required to connect to a remote server.
|
class |
ServerConnectionException
An exception thrown while connecting or using a ServerConnectionDescriptor.
|
interface |
ServerVersionInfo
Version information for a connected server.
|
class |
StructureAttributeType
This class enumerates the valid types of attribute supported by a
ParameterProvider . |
interface |
StructuredPropertyDefinition
This interfaces defines a structured property definition.
|
interface |
StructuredValue
This interface defines a structured value.
|
interface |
SystemServerConnectionDescriptor
Defines the basic data elements that describes a server connection.
|
Modifier and Type | Interface and Description |
---|---|
interface |
CollectionType
Defines the measurement information associated with collections.
|
interface |
Column
This defines the properties of a set of columns.
|
class |
ColumnCountException
A
ColumnCountException is thrown when the number of columns in the data
did not match the number of columns specified in the data model. |
interface |
ColumnGroup
This defines the properties of a column group.
|
class |
ColumnGroupType
This class enumerates the valid types for a ColumnGroup.
|
interface |
DataModel
This defines the properties of a set of columns.
|
class |
DataModelException
An exception thrown when there is a mismatch between physical set of data
and its expected data model.
|
interface |
DataModelFactory
A factory class that creates and manipulates instances
of
Column and DataModel . |
interface |
ExtendedMeasure
This is an empty marker interface which identifies classes that provide
extended measure metadata.
|
interface |
ExtendedStorage
This is an empty marker interface which identifies classes that provide
extended storage metadata.
|
class |
GeometryType
Defines the different categories of geo objects.
|
interface |
GeoType
Defines the different categories of geo objects.
|
interface |
GlobalValues
This defines the set of global values which are usually computed by
a stream via a "setglobals" node.
|
class |
InvalidColumnValueException
An
InvalidColumnValueException is thrown when the value supplied for a column
is not consistent with its storage type. |
interface |
ListStorage
Defines the storage metadata associated with lists.
|
interface |
MDate
This identifies a Modeler date value.
|
interface |
MDatetime
This identifies a Modeler date/time value.
|
class |
MeasureType
This class enumerates the valid measures for columns in a
DataModel . |
interface |
MissingValueDefinition
This defines the attributes associated with missing values.
|
class |
ModelingRole
This class enumerates the valid modeling roles for columns in a
DataModel . |
interface |
ModelOutputMetadata
This defines the metadata associated with a Column
generated by a model.
|
interface |
MTime
This identifies a Modeler time value.
|
interface |
MTimestamp
This identifies a Modeler timestamp value.
|
interface |
RowSet
This defines the properties of a tabular dataset.
|
interface |
RowSetFactory
A factory class that creates instances of
RowSet . |
class |
StorageType
This class enumerates the valid storage types for columns in a
DataModel
or parameters. |
class |
UnknownColumnException
An
UnknownColumnException is thrown when a column name is used that does not
exist in the data model. |
Modifier and Type | Interface and Description |
---|---|
interface |
Expression
This interface encapsulates details of a CLEM expression.
|
interface |
Parser
This interface encapsulates the functionality for parsing CLEM expressions.
|
class |
ParserException
A
ParserException is thrown to indicate that an attempt to parse a String
to an Expression failed. |
Modifier and Type | Interface and Description |
---|---|
interface |
ASLCompiler
Deprecated.
|
interface |
Extension
An interface that provides access to the information about an
extension.
|
interface |
ExtensionObject
An interface that defines the basic functionality of objects
defined by the Modeler extensions framework (CLEF).
|
interface |
ExtensionOutput
An interface that defines a
BuiltObject defined by an extension. |
interface |
ExtensionProcessor
An interface that specifies a
Processor defined by an extension. |
Modifier and Type | Class and Description |
---|---|
class |
ASContainerEntry |
class |
ASContainerHelper |
interface |
AslContext
This class defines the context information that is passed to an ASL generator.
|
interface |
CatalogDefinition
The definition of a catalog i.e. a collection of related objects.
|
class |
DataProviderException
Indicates a diagnostic fault occurred during output data model computation of an extension.
|
class |
Diagnostic
Represents a diagnostic message.
|
interface |
DocumentOutputManager
A document output manager contains all document outputs managed by the application session.
|
interface |
ExecutionContext
This class defines the basic context information that is passed to an execution handler.
|
interface |
ExecutionXMLContext
This class defines the context information that is passed to an execution XML generator.
|
interface |
ExtensionContext
This class provides information to extension delegates.
|
class |
ExtensionException
Indicates an extension related diagnostic fault occurred.
|
interface |
ExtensionInteractor
Manages an interactive session with an extension peer.
|
class |
ExtensionObjectEvent
Represents an event on an extension object.
|
interface |
ManagedServerConnectionDescriptor
Defines the basic data elements that describes a remote server connection
in a managed session.
|
interface |
ManagedSession
A managed session provides access to Modeler manager objects that
manage streams, models and outputs.
|
interface |
ModelOutputManager
A model output manager contains all model outputs managed by the application session.
|
interface |
NodeContext
This class defines the context information that is passed to a node delegate.
|
interface |
OutputContext
This class defines the context information that is passed to an output delegate.
|
interface |
ProcessorStreamManager
A stream manager contains all streams being managed by the session.
|
interface |
Properties
Provides functionality for accessing properties declared by the extension.
|
interface |
ServerCatalogManager
The server catalog manager.
|
interface |
SessionContext
Base class for contexts that are passed to session-specific delegates.
|
interface |
SessionObjectFactory
Creates session artefacts on behalf of extensions.
|
interface |
ShutdownContext
Defines information about the way the application is being shut down.
|
interface |
StartupContext
Defines information about the way the application was invoked.
|
Modifier and Type | Interface and Description |
---|---|
interface |
DataModelProvider
A data model provider computes an output data model for a given
input data model, set of properties, the object whose data model
is being computed and the session.
|
interface |
ExecutionPlanProvider
An XPlan provider computes an execution plan (in the form of an Execution XML document)
|
interface |
ExtensionListener
Defines an object that listens for specific events that may occur
on an extension.
|
interface |
ExtensionListener2
Defines additional extension listener methods that listen for startup and shutdown events
on the extension.
|
interface |
MessageListener
Listens for asynchronous messages arriving at an extension interactor.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AslGenerator
Defines the methods supported by an execution handler that generates ASL.
|
interface |
ExecutionHandler
This is the base class for execution handlers - objects which define how a
Processor
should be executed. |
interface |
ExecutionXMLGenerator
Defines the methods supported by an execution that generates Execution XML.
|
interface |
ExtensionDelegate
Defines the methods supported by an extension delegate.
|
interface |
ExtensionObjectDelegate
Defines the basic methods supported by an extension object delegate.
|
interface |
NodeDelegate
Defines the methods supported by a node delegate.
|
interface |
OutputDelegate
Defines the methods supported by an output delegate.
|
interface |
PhasedAslGenerator
Defines the methods supported by an execution handler that generates ASL with multi-phase support.
|
interface |
PropertyValidator
This is a marker class for delegates that support property validation.
|
interface |
PropertyValueProvider |
Modifier and Type | Interface and Description |
---|---|
interface |
ControlManager
Defines the functionality associated with a control manager.
|
interface |
ExtensionObjectWindowHandle
Defines the functionality of an extension object window
handle.
|
interface |
NativeWindowHandle
Defines the functionality associated with a native window.
|
class |
PropertyControlEvent |
interface |
WindowHandle
Defines the functionality associated with an object window handle.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ActionHandler
Defines the functionality associated with an action handler.
|
interface |
CustomFieldSelectionTable
/** A CLEF MultiFieldSelectionTableControl must sub class JTable and implements both
PropertyControl and this interface. |
interface |
CustomFieldSelectionTableModel
A CLEF MultiFieldSelectionTableControl must sub class JTable and implements
PropertyControl and
CustomFieldSelectionTable . |
interface |
CustomRowCloneable
Supplemental interface of
CustomRowMovable . |
interface |
CustomRowMovable
Like
CustomFieldSelectionModel if the custom JTable allow users move it's rows then
it must also implement this interface so the move buttons will be added |
interface |
DataModelHandler |
interface |
ExtensionObjectFrame
Defines the functionality associated with extension object frame
windows i.e. windows used to display with model or document outputs.
|
interface |
ExtensionObjectPanel
Defines the functionality associated with extension object panels.
|
interface |
ExtensionObjectUIDelegate
Defines the methods supported by an extension object UI delegate.
|
interface |
PostUIInitialiseHandler |
interface |
PropertyControl
Defines the functionality associated with a custom property control
on a PropertiesPanel.
|
interface |
PropertyControlListener |
Modifier and Type | Interface and Description |
---|---|
interface |
DecisionListModel
A model built by the interactive Decision List algorithm.
|
interface |
DecisionListModelInteractiveState
Saved state from an interactive Decision List modelling session.
|
interface |
DecisionListModelInteractor
Interactive model building using the Decision List algorithm.
|
interface |
DecisionListTaskFactory
Task factory for a
DecisionListModelInteractor . |
Modifier and Type | Interface and Description |
---|---|
interface |
CompositeModelDetail
This interface encapsulates the representation detail of a composite model.
|
interface |
ModelDetail
This interface encapsulates the representation detail of a data mining model.
|
class |
ModelType
This class enumerates the valid model types.
|
class |
PMMLModelType
Enumerates the model types specified by PMML 4.0.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ServerDatabaseConnection
This encapsulates the functionality of an object that represents a connection
to a database.
|
interface |
ServerFile
This encapsulates the representation of a file on the server file system.
|
interface |
ServerFileSystem
This encapsulates the functionality for representing the file system
on the data mining server's host.
|
class |
ServerResourceException
An exception thrown while accessing a server resource.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Operator
This defines an operator.
|
interface |
OperatorSet
This defines a set of operators.
|
interface |
ParameterDefinition
This defines a parameter.
|
interface |
ParameterGroupDefinition
This defines a parameter group which allows related parameters to be collected together.
|
interface |
RuntimeDescriptor
This defines information about a specific runtime.
|
interface |
Runtimes
This provides mechanisms for managing runtime definitions.
|
interface |
ValueConstraint
This provides a definition of a valid value for a parameter.
|
Modifier and Type | Interface and Description |
---|---|
interface |
RuntimeProvider |
Modifier and Type | Interface and Description |
---|---|
interface |
AdministratorSession
This provides a means for carrying out administration activities via a connection to a server.
|
interface |
LocaleInfo
This interface defines locale-sensitive information associated with a
Session . |
interface |
Repository
This defines the basic functionality for a content repository.
|
interface |
Session
A session is the main interface through which users of the Modeler API
access the API features.
|
class |
SessionException
An exception thrown while creating a
Session or performing a
task within a Session . |
class |
SessionFactory
A session factory is used to create instances of
Session . |
interface |
SystemSession
Defines the functionality of a system session.
|
interface |
UIResources
This interface provides access to UI-related resources.
|
Modifier and Type | Class and Description |
---|---|
class |
ExecutionFeedbackEvent
Feedback received from an execution task.
|
interface |
ExecutionFeedbackListener
Listener for
ExecutionFeedbackEvent . |
interface |
ExecutionHandle
Monitors and controls execution of a
Task by a
Session . |
class |
ExecutionState
This class enumerates the task execution states.
|
class |
ExecutionStateEvent
Indicates a state change in a task.
|
interface |
ExecutionStateListener
Listener for
ExecutionStateEvent . |
interface |
Task
A
Task represents an operation that can be performed by the
Modeler API. |
interface |
TaskFactory
The
TaskFactory is used to create instances of Task . |
interface |
TaskRunner
The
TaskRunner provides a convenient way of creating and running
tasks synchronously. |
Modifier and Type | Interface and Description |
---|---|
interface |
BuiltObject
This encapsulates the concrete results of executing
ObjectBuilder
nodes. |
interface |
CFProcessor
This identifies
Processor objects that are implemented via the Component Framework. |
interface |
Comment
This represents a comment in a stream.
|
interface |
CompositeModelApplier
This encapsulates the auto-model applier nodes
ModelApplier
that can ensemble the scores from multiple models into a single score. |
interface |
CompositeModelBuilder
This encapsulates the auto-model builder nodes
ModelBuilder
that can build and evaluate multiple models using different modeling algorithms
and settings. |
interface |
CompositeModelOutput
This encapsulates the concrete results of executing
ModelBuilder
nodes or by opening or importing Composite models. |
interface |
CompositeModelOwner
This encapsulates objects that own auto-built models.
|
interface |
CompositeModelResult
This encapsulates the concrete results for the individual models forming the Composite Model.
|
interface |
CompositeProcessor
This encapsulates the functionality of any supernode whose behaviour
is determined by its constituent nodes.
|
interface |
CompositeProcessorDiagram
This is the diagram used by
CompositeProcessor objects to store
nodes. |
class |
CompositeProcessorType
This class enumerates the types of supernodes.
|
interface |
DataReader
This encapsulates the functionality of a data node that reads records e.g.
|
interface |
DataTransformer
This encapsulates the functionality of a standard inline data node .
|
interface |
DataWriter
This encapsulates the functionality of a node that writes records e.g.
|
interface |
DiagramConnector
A node which provides a connection point between a
CompositeProcessorDiagram
and its containing diagram. |
interface |
DocumentBuilder
This encapsulates the functionality of a node that builds a viewable output object
such as a table, graph or report.
|
interface |
DocumentOutput
This encapsulates the concrete results of executing
DocumentBuilder
nodes that produce generic document-type outputs. |
class |
DocumentOutputType
This class enumerates the types of document outputs that are generated by the
different
ProcessorType that are DocumentBuilder s
or which can be imported. |
class |
ExportFormatException
Indicates that an attempt was made to export a built object using an
unsupported file format.
|
interface |
GraphBuilder
This encapsulates the functionality of a node that builds a graph output.
|
interface |
GraphOutput
This encapsulates the concrete results of executing
DocumentBuilder
nodes that produce objects that are based on graphs. |
interface |
InitialProcessor
This encapsulates the functionality of any node that begins a
sequence of nodes.
|
interface |
InlineProcessor
This encapsulates the functionality of any node that allows data to
flow through it i.e., a
Processor that is neither a InitialProcessor
nor a TerminalProcessor . |
interface |
InteractiveOutput
This encapsulates the concrete results of executing
ObjectBuilder
nodes that can generate interactive outputs. |
interface |
Interactor
Interactive services of an
InteractiveOutput . |
class |
InvalidEditException
An exception thrown when an invalid attempt is made to edit the links between
two or more nodes.
|
interface |
ModelApplier
This encapsulates the functionality of an inline node that applies models.
|
interface |
ModelBuilder
This encapsulates the functionality of a node that builds a model output object.
|
interface |
ModelInteractor
Services for interactive modelling.
|
class |
ModelInteractorType
Enumerates the types of model interactor that can be instantiated by an
InteractiveOutput . |
interface |
ModelOutput
This encapsulates the concrete results of executing
ModelBuilder
nodes or by opening or importing models. |
class |
ModelOutputType
This class enumerates the types of model outputs that are generated by the
different
ProcessorType that are ModelBuilders
or which can be imported. |
interface |
ObjectBuilder
This encapsulates the functionality of a node that builds an output object
such as a model or graph.
|
interface |
OutputFactory
A factory class that creates
BuiltObject instances. |
interface |
Processor
This is the base interface for all nodes.
|
interface |
ProcessorDiagram
This is the container used to assemble
Processor objects into a
connected flow or well-formed sequence of nodes. |
interface |
ProcessorFactory
A factory class that creates
Processor instances. |
interface |
ProcessorFilter
This is used to define arbitrary criteria for filtering nodes e.g. during searches.
|
interface |
ProcessorStream
This is the top-level container used to assemble
Processor objects into a
connected "flow". |
class |
ProcessorType
This clas enumerates the types of nodes.
|
interface |
PublishedImage
The result of publishing a
DataWriter . |
interface |
ReportBuilder
This encapsulates the functionality of a node that builds a report.
|
interface |
ReportOutput
This encapsulates the concrete results of executing
DocumentBuilder
nodes that produce report-type outputs such as quality reports. |
interface |
RowSetBuilder
This encapsulates the functionality of a node that builds an output based
on a
RowSet . |
interface |
RowSetOutput
This encapsulates the concrete results of executing
DocumentBuilder
nodes that produce objects that are based on underlying RowSet
such as tables and matrices. |
interface |
StreamValidationResult |
interface |
TerminalProcessor
This encapsulates the functionality of any node that terminates a
particular sequence of nodes.
|
interface |
Updatable
This represents
Processor objects that can be updated by Updating objects. |
interface |
Updater
This represents
Processor objects that update Updatable objects. |
(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.