Package | Description |
---|---|
com.spss.psapi.extensions |
This provides definitions associated with the Modeler Extensions Framework (CLEF).
|
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 | Interface and Description |
---|---|
interface |
ExtensionProcessor
An interface that specifies a
Processor defined by an extension. |
Modifier and Type | Method and Description |
---|---|
Processor |
Repository.retrieveProcessor(java.lang.String path,
java.lang.String version,
java.lang.String label,
ProcessorDiagram diagram)
Retrieves a node from the specified path and inserts it into the supplied diagram.
|
Modifier and Type | Method and Description |
---|---|
ExecutionHandle |
Session.run(Processor[] nodes,
java.util.Collection results)
Executes the supplied array of nodes synchronously and waits for them to complete.
|
ExecutionHandle |
Session.spawn(Processor[] nodes,
java.util.Collection builtObjects)
Executes the supplied array of nodes asynchronously.
|
java.lang.String |
Repository.storeProcessor(Processor node,
java.lang.String path,
java.lang.String label)
Stores a node to the specified location.
|
Modifier and Type | Method and Description |
---|---|
Processor |
TaskRunner.insertNodeFromFile(java.lang.String filename,
ProcessorDiagram diagram)
Reads and returns a node from the specified file, inserting it into
the supplied diagram.
|
Modifier and Type | Method and Description |
---|---|
Task |
TaskFactory.createExportModelTask(Processor modelApplier,
java.io.OutputStream outputStream,
FileFormat fileFormat)
Creates a task that exports a
Processor node
to an output stream using the specified FileFormat name. |
Task |
TaskFactory.createSaveProcessorTask(Processor node,
java.io.OutputStream outputStream)
Creates a task that saves a
Processor object to an output stream. |
Task |
TaskFactory.createValidateStreamTask(Processor node)
Creates a task that validate a stream and get required fields, the result of the task is
StreamValidationResult , which could be got from task.getResult(). |
void |
TaskRunner.exportModelSummaryToFile(Processor node,
java.lang.String filename,
FileFormat fileFormat)
Exports the model summary in the supplied node to a file using the specified file format.
|
void |
TaskRunner.exportModelToFile(Processor node,
java.lang.String filename,
FileFormat fileFormat)
Exports the model in the supplied node to a file using the specified file format.
|
void |
TaskRunner.saveNodeToFile(Processor node,
java.lang.String filename)
Saves the node to the specified file location.
|
Modifier and Type | Interface and Description |
---|---|
interface |
CFProcessor
This identifies
Processor objects that are implemented via the Component Framework. |
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 |
CompositeProcessor
This encapsulates the functionality of any supernode whose behaviour
is determined by its constituent nodes.
|
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 |
GraphBuilder
This encapsulates the functionality of a node that builds a graph output.
|
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 |
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 |
ObjectBuilder
This encapsulates the functionality of a node that builds an output object
such as a model or graph.
|
interface |
ReportBuilder
This encapsulates the functionality of a node that builds a report.
|
interface |
RowSetBuilder
This encapsulates the functionality of a node that builds an output based
on a
RowSet . |
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. |
Modifier and Type | Method and Description |
---|---|
Processor |
ProcessorDiagram.create(java.lang.String nodeType,
java.lang.String name)
Creates a
Processor of the specified type and adds it to this diagram. |
Processor |
ProcessorDiagram.createAt(java.lang.String nodeType,
java.lang.String name,
int x,
int y)
Creates a
Processor of the specified type and adds it to this diagram at the specified
location. |
Processor |
ProcessorFactory.createExtensionProcessor(java.lang.String extensionId,
java.lang.String extensionNodeId,
java.lang.String name)
Creates a
Processor whose definition is specified
by an extension and adds it to the stream. |
Processor |
ProcessorFactory.createExtensionProcessor(java.lang.String extensionId,
java.lang.String extensionNodeId,
java.lang.String name,
ProcessorDiagram diagram)
Creates a
Processor whose definition is specified
by an extension and adds it to the supplied diagram. |
Processor |
ProcessorDiagram.createModelApplier(ModelOutput modelOutput,
java.lang.String name)
Creates a
ModelApplier derived from the supplied model output object. |
Processor |
ProcessorDiagram.createModelApplierAt(ModelOutput modelOutput,
java.lang.String name,
int x,
int y)
Creates a
ModelApplier derived from the supplied model output object. |
Processor |
ProcessorFactory.createProcessor(ProcessorType type,
java.lang.String name)
Creates a
Processor of the specified type and adds it to the stream. |
Processor |
ProcessorFactory.createProcessor(ProcessorType type,
java.lang.String name,
ProcessorDiagram diagram)
Creates a
Processor of the specified type and adds it to the supplied diagram. |
Processor |
ProcessorFactory.createProcessor(java.lang.String nodeTypeName,
java.lang.String name)
Creates a
Processor of the specified type and adds it to the stream. |
Processor |
ProcessorFactory.createProcessor(java.lang.String nodeTypeName,
java.lang.String name,
ProcessorDiagram diagram)
Creates a
Processor of the specified type and adds it to the supplied diagram. |
Processor |
ProcessorFactory.createProcessorAt(java.lang.String nodeTypeName,
java.lang.String name,
ProcessorDiagram diagram,
int x,
int y)
Creates a
Processor of the specified type and adds it to the supplied diagram. |
Processor |
ProcessorDiagram.findByID(java.lang.String id)
Returns the node with the supplied ID or
null
if no such node exists. |
Processor |
ProcessorDiagram.findByType(java.lang.String type,
java.lang.String label)
Returns the node with the supplied type and/or label.
|
Processor |
ProcessorDiagram.findProcessorForID(java.lang.String id)
Returns the node with the supplied ID or
null
if no such node exists. |
Processor |
ProcessorDiagram.findProcessorForID(java.lang.String id,
boolean recursive)
Returns the node with the supplied ID or
null
if no such node exists. |
Processor |
CompositeProcessorDiagram.getInputConnector()
Returns the input connector from this diagram,
or
null if the diagram belongs to
an initial node and has no input connector. |
Processor |
CompositeProcessorDiagram.getOutputConnector()
Returns the output connector from this diagram,
or
null if the diagram belongs to
a terminal node and has no output connector. |
Processor |
Updatable.getUpdater()
Returns the
Processor that is updating this one or null if there is no updater. |
Processor |
ProcessorDiagram.predecessorAt(Processor node,
int index)
Returns the specified immediate predecessor of the supplied node or
null
if the index is out of bounds |
Processor |
ProcessorDiagram.successorAt(Processor node,
int index)
Returns the specified immediate successor of the supplied node or
null
if the index is out of bounds |
Modifier and Type | Method and Description |
---|---|
boolean |
ProcessorFilter.accept(Processor node)
Returns
true if the node should be included by the filter. |
void |
ProcessorDiagram.delete(Processor node)
Deletes the specified node from this diagram.
|
void |
ProcessorDiagram.disconnect(Processor node)
Removes any links between the supplied node and any other nodes in this diagram.
|
boolean |
ProcessorDiagram.isEnabled(Processor node)
Returns
true if the supplied node is enabled. |
boolean |
ProcessorDiagram.isOwner(Processor node)
Returns
true if the node is owned by this diagram. |
boolean |
ProcessorDiagram.isValidLink(Processor source,
Processor target)
Returns
true if it would be valid to create a link between the specified source and target nodes. |
void |
ProcessorDiagram.link(Processor source,
java.util.List targets)
Creates new links between the source and each target node in the supplied
list.
|
void |
ProcessorDiagram.link(Processor source,
Processor target)
Creates a new link between the source and the target.
|
void |
ProcessorDiagram.linkBetween(Processor inserted,
Processor source,
Processor target)
Connects a
Processor between two other instances and sets the position
of the inserted node to be between those. |
void |
CompositeProcessorDiagram.linkFromInputConnector(Processor node)
Creates a link from the input connector to the supplied node.
|
void |
CompositeProcessorDiagram.linkToOutputConnector(Processor node)
Creates a link from the supplied node to the output connector.
|
void |
ProcessorDiagram.linkUpdater(Processor updater,
Processor updatable)
Creates a new update link between the updater and the updatable.
|
Processor |
ProcessorDiagram.predecessorAt(Processor node,
int index)
Returns the specified immediate predecessor of the supplied node or
null
if the index is out of bounds |
int |
ProcessorDiagram.predecessorCount(Processor node)
Returns the number of immediate predecessors of the supplied node.
|
java.util.List |
ProcessorDiagram.predecessors(Processor node)
Returns the immediate predecessors of the supplied node.
|
void |
ProcessorDiagram.replace(Processor originalNode,
Processor replacementNode,
boolean discardOriginal)
Replaces the specified node from this diagram.
|
ExecutionHandle |
ProcessorStream.runSelected(Processor[] nodes,
java.util.Collection results)
Executes the supplied array of nodes synchronously and waits for them to complete.
|
ExecutionHandle |
CompositeProcessorDiagram.runSelected(Processor[] nodes,
java.util.Collection results)
Executes the supplied array of nodes synchronously and waits for them to complete.
|
void |
ProcessorDiagram.setEnabled(Processor node,
boolean enabled)
Sets the enabled state of the supplied node.
|
void |
Processor.setPositionBetween(Processor source,
Processor target)
Sets the position of the node in the
ProcessorDiagram so it is positioned
between the supplied nodes. |
Processor |
ProcessorDiagram.successorAt(Processor node,
int index)
Returns the specified immediate successor of the supplied node or
null
if the index is out of bounds |
int |
ProcessorDiagram.successorCount(Processor node)
Returns the number of immediate successors of the supplied node.
|
java.util.List |
ProcessorDiagram.successors(Processor node)
Returns the immediate successors of the supplied node.
|
void |
ProcessorDiagram.unlink(Processor source,
java.util.List targets)
Removes any direct links between the source and each object in the targets list.
|
void |
ProcessorDiagram.unlink(Processor source,
Processor target)
Removes any direct link between the source and the target.
|
void |
CompositeProcessorDiagram.unlinkFromInputConnector(Processor node)
Removes any direct link from the input connector to the supplied node.
|
void |
CompositeProcessorDiagram.unlinkToOutputConnector(Processor node)
Removes any direct link from the supplied node to the output connector.
|
void |
ProcessorDiagram.unlinkUpdater(Processor updater,
Processor updatable)
Removes any update link between the updater and the updatable.
|
Modifier and Type | Method and Description |
---|---|
java.util.List |
ProcessorDiagram.findDownstream(java.util.List<Processor> fromNodes)
Searches from the supplied list of nodes and returns the set of nodes
downstream of the supplied nodes.
|
java.util.List |
ProcessorDiagram.findUpstream(java.util.List<Processor> fromNodes)
Searches from the supplied list of nodes and returns the set of nodes
upstream of the supplied nodes.
|
Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.