com.spss.psapi.core

Interface PropertyFactory



  • public interface PropertyFactory
    This provides convenience methods for constructing and decomposing structured property values.
    Since:
    PSAPI 1.0
    Version:
    1.0
    Author:
    Julian Clinton
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean containsAggregateOpsEntryMax(java.lang.Object entry)
      Returns true if the maximum value is being calculated in the supplied aggregate entry, false otherwise.
      boolean containsAggregateOpsEntryMean(java.lang.Object entry)
      Returns true if the mean is being calculated in the supplied aggregate entry, false otherwise.
      boolean containsAggregateOpsEntryMin(java.lang.Object entry)
      Returns true if the minimum value is being calculated in the supplied aggregate entry, false otherwise.
      boolean containsAggregateOpsEntrySDev(java.lang.Object entry)
      Returns true if the standard deviation is being calculated in the supplied aggregate entry, false otherwise.
      boolean containsAggregateOpsEntrySum(java.lang.Object entry)
      Returns true if the sum is being calculated in the supplied aggregate entry, false otherwise.
      boolean containsSetGlobalsEntryMax(java.lang.Object entry)
      Returns true if the maximum value is being calculated in the supplied set globals entry, false otherwise.
      boolean containsSetGlobalsEntryMean(java.lang.Object entry)
      Returns true if the mean is being calculated in the supplied set globals entry, false otherwise.
      boolean containsSetGlobalsEntryMin(java.lang.Object entry)
      Returns true if the minimum value is being calculated in the supplied set globals entry, false otherwise.
      boolean containsSetGlobalsEntrySDev(java.lang.Object entry)
      Returns true if the standard deviation is being calculated in the supplied set globals entry, false otherwise.
      boolean containsSetGlobalsEntrySum(java.lang.Object entry)
      Returns true if the sum is being calculated in the supplied set globals entry, false otherwise.
      java.lang.Object createAggregateOpsEntry(boolean sum, boolean min, boolean max, boolean mean, boolean sdev)
      Creates an entry for the aggregate operations.
      java.lang.Object createBalanceEntry(java.lang.String condition, double factor)
      Creates an entry for balancing records (i.e., modifying the proportion of records using the specified condition and factor).
      java.lang.Object createDecisionListInteractiveState(java.lang.Object interactorMetadata, byte[] viewerMetadata, ModelDetail workingModel)
      Creates an interactive state object for a Decision List modelling session suitable for assignment to the DECISION_LIST_INTERACTIVE_STATE property of a model builder.
      StructuredValue createDefaultStructuredValue(StructuredPropertyDefinition definition)
      Returns a new structured value using the defaults specified by the structured property definition.
      java.lang.Object createFixedWidthFileEntry(java.lang.String columnName, int startColumn, int width)
      Creates an entry that specifies the name, position and width attributes of a column in a fixed width column text file.
      java.lang.Object createFlagEntry(java.lang.Object trueValue, java.lang.Object falseValue)
      Creates an entry that can be used to specify the desired true and false values in a column representing a binary indicator.
      java.lang.Object createPEVConnection(java.lang.String description, java.lang.String applicationView, java.lang.String versionLabel, java.lang.String environment, java.lang.String dataProvider)
      Returns a value suitable for assignment to the IMPORT_PEV_CONNECTION property of a PEV Import Processor.
      java.lang.Object createRangeBounds(java.lang.Object minValue, java.lang.Object maxValue)
      Creates an entry that can be used to specify the desired minimum and maximum of values in a column representing continuous data.
      java.lang.Object createSetGlobalsEntry(boolean sum, boolean min, boolean max, boolean mean, boolean sdev)
      Creates an entry for the set globals operations.
      java.lang.Object createSortEntry(java.lang.String columnName, boolean isAscending)
      Creates an entry for sorting on a named column using the specified direction.
      java.lang.String getBalanceEntryCondition(java.lang.Object entry)
      Returns the condition for the supplied balance entry.
      double getBalanceEntryFactor(java.lang.Object entry)
      Returns the factor for the supplied balance entry.
      java.lang.Object getDecisionListInteractiveStateInteractorMetadata(java.lang.Object state)
      Returns the interactor metadata from a Decision List interactive state.
      byte[] getDecisionListInteractiveStateViewerMetadata(java.lang.Object state)
      Returns the viewer metadata from a Decision List interactive state.
      ModelDetail getDecisionListInteractiveStateWorkingModel(java.lang.Object state)
      Returns the working model detail from a Decision List interactive state.
      java.lang.String getFixedWidthFileEntryColumnName(java.lang.Object entry)
      Returns the column name for the supplied fixed width file entry.
      int getFixedWidthFileEntryStartColumn(java.lang.Object entry)
      Returns the start column for the supplied fixed width file entry, starting from 1.
      int getFixedWidthFileEntryWidth(java.lang.Object entry)
      Returns the column width for the supplied fixed width file entry, starting from 1.
      java.lang.Object getFlagFalseValue(java.lang.Object entry)
      Returns the false value for the supplied flag entry or null if the value is unknown.
      java.lang.Object getFlagTrueValue(java.lang.Object entry)
      Returns the true value for the supplied flag entry or null if the value is unknown.
      java.lang.String getPEVConnectionApplicationView(java.lang.Object connection)
      Returns the application view from a PEV connection object.
      java.lang.String getPEVConnectionDataProvider(java.lang.Object connection)
      Returns the data provider definition from a PEV connection object or null if the DPD is not set.
      java.lang.String getPEVConnectionDescription(java.lang.Object connection)
      Returns the description from a PEV connection object.
      java.lang.String getPEVConnectionEnvironment(java.lang.Object connection)
      Returns the environment from a PEV connection object.
      java.lang.String getPEVConnectionVersionLabel(java.lang.Object connection)
      Returns the version label from a PEV connection object.
      java.lang.Object getRangeMaxValue(java.lang.Object entry)
      Returns the upper bound for the supplied range bounds entry or null if the value is unknown.
      java.lang.Object getRangeMinValue(java.lang.Object entry)
      Returns the lower bound for the supplied range bounds entry or null if the value is unknown.
      java.lang.String getSortEntryColumnName(java.lang.Object entry)
      Returns the column name for the supplied sort entry.
      boolean isFlagDefined(java.lang.Object entry)
      Returns true of this flag entry is fully specified.
      boolean isRangeDefined(java.lang.Object entry)
      Returns true of this range bounds object is fully specified.
      boolean isSortEntryAscending(java.lang.Object entry)
      Returns true if the supplied sort entry is ascending, false otherwise.
    • Method Detail

      • createSortEntry

        java.lang.Object createSortEntry(java.lang.String columnName,
                                       boolean isAscending)
        Creates an entry for sorting on a named column using the specified direction.
        Parameters:
        columnName - the column name
        isAscending - flag indicating whether the sort order is ascending
        Returns:
        an entry incorporating the supplied property settings
      • getSortEntryColumnName

        java.lang.String getSortEntryColumnName(java.lang.Object entry)
        Returns the column name for the supplied sort entry.
        Parameters:
        entry - the sort entry
        Returns:
        the column name
      • isSortEntryAscending

        boolean isSortEntryAscending(java.lang.Object entry)
        Returns true if the supplied sort entry is ascending, false otherwise.
        Parameters:
        entry - the sort entry
        Returns:
        true if the supplied sort entry is ascending
      • createAggregateOpsEntry

        java.lang.Object createAggregateOpsEntry(boolean sum,
                                               boolean min,
                                               boolean max,
                                               boolean mean,
                                               boolean sdev)
        Creates an entry for the aggregate operations.
        Parameters:
        sum - indicates whether the sum should calculated
        min - indicates whether the minimum value should calculated
        max - indicates whether the maximum value should calculated
        mean - indicates whether the mean should calculated
        sdev - indicates whether the standard deviation should calculated
        Returns:
        an entry incorporating the supplied property settings
      • containsAggregateOpsEntrySum

        boolean containsAggregateOpsEntrySum(java.lang.Object entry)
        Returns true if the sum is being calculated in the supplied aggregate entry, false otherwise.
        Parameters:
        entry - the aggregate entry
        Returns:
        true if the sum is being calculated
      • containsAggregateOpsEntryMean

        boolean containsAggregateOpsEntryMean(java.lang.Object entry)
        Returns true if the mean is being calculated in the supplied aggregate entry, false otherwise.
        Parameters:
        entry - the aggregate entry
        Returns:
        true if the mean is being calculated
      • containsAggregateOpsEntryMin

        boolean containsAggregateOpsEntryMin(java.lang.Object entry)
        Returns true if the minimum value is being calculated in the supplied aggregate entry, false otherwise.
        Parameters:
        entry - the aggregate entry
        Returns:
        true if the minimum value is being calculated
      • containsAggregateOpsEntryMax

        boolean containsAggregateOpsEntryMax(java.lang.Object entry)
        Returns true if the maximum value is being calculated in the supplied aggregate entry, false otherwise.
        Parameters:
        entry - the aggregate entry
        Returns:
        true if the maximum value is being calculated
      • containsAggregateOpsEntrySDev

        boolean containsAggregateOpsEntrySDev(java.lang.Object entry)
        Returns true if the standard deviation is being calculated in the supplied aggregate entry, false otherwise.
        Parameters:
        entry - the aggregate entry
        Returns:
        true if the standard deviation is being calculated
      • createBalanceEntry

        java.lang.Object createBalanceEntry(java.lang.String condition,
                                          double factor)
        Creates an entry for balancing records (i.e., modifying the proportion of records using the specified condition and factor).
        Parameters:
        condition - the condition to be met before modifying the proportion
        factor - value specifying how the proportion of records that meet the condition should be modified.
        Returns:
        an entry incorporating the supplied property settings
      • getBalanceEntryCondition

        java.lang.String getBalanceEntryCondition(java.lang.Object entry)
        Returns the condition for the supplied balance entry.
        Parameters:
        entry - the balance entry
        Returns:
        the balance condition
      • getBalanceEntryFactor

        double getBalanceEntryFactor(java.lang.Object entry)
        Returns the factor for the supplied balance entry.
        Parameters:
        entry - the balance entry
        Returns:
        the factor
      • createFixedWidthFileEntry

        java.lang.Object createFixedWidthFileEntry(java.lang.String columnName,
                                                 int startColumn,
                                                 int width)
        Creates an entry that specifies the name, position and width attributes of a column in a fixed width column text file.
        Parameters:
        columnName - the column name
        startColumn - the first column containing the value, starting from 1
        width - the width of the column
        Returns:
        an entry incorporating the supplied property settings
      • getFixedWidthFileEntryColumnName

        java.lang.String getFixedWidthFileEntryColumnName(java.lang.Object entry)
        Returns the column name for the supplied fixed width file entry.
        Parameters:
        entry - the fixed width file entry
        Returns:
        the column name
      • getFixedWidthFileEntryStartColumn

        int getFixedWidthFileEntryStartColumn(java.lang.Object entry)
        Returns the start column for the supplied fixed width file entry, starting from 1.
        Parameters:
        entry - the fixed width file entry
        Returns:
        the position of the first column
      • getFixedWidthFileEntryWidth

        int getFixedWidthFileEntryWidth(java.lang.Object entry)
        Returns the column width for the supplied fixed width file entry, starting from 1.
        Parameters:
        entry - the fixed width file entry
        Returns:
        the width of the column
      • createSetGlobalsEntry

        java.lang.Object createSetGlobalsEntry(boolean sum,
                                             boolean min,
                                             boolean max,
                                             boolean mean,
                                             boolean sdev)
        Creates an entry for the set globals operations.
        Parameters:
        sum - indicates whether the sum should calculated
        min - indicates whether the minimum value should calculated
        max - indicates whether the maximum value should calculated
        mean - indicates whether the mean should calculated
        sdev - indicates whether the standard deviation should calculated
        Returns:
        an entry incorporating the supplied property settings
      • containsSetGlobalsEntrySum

        boolean containsSetGlobalsEntrySum(java.lang.Object entry)
        Returns true if the sum is being calculated in the supplied set globals entry, false otherwise.
        Parameters:
        entry - the set globals entry
        Returns:
        true if the sum is being calculated
      • containsSetGlobalsEntryMean

        boolean containsSetGlobalsEntryMean(java.lang.Object entry)
        Returns true if the mean is being calculated in the supplied set globals entry, false otherwise.
        Parameters:
        entry - the set globals entry
        Returns:
        true if the mean is being calculated
      • containsSetGlobalsEntryMin

        boolean containsSetGlobalsEntryMin(java.lang.Object entry)
        Returns true if the minimum value is being calculated in the supplied set globals entry, false otherwise.
        Parameters:
        entry - the set globals entry
        Returns:
        true if the minimum value is being calculated
      • containsSetGlobalsEntryMax

        boolean containsSetGlobalsEntryMax(java.lang.Object entry)
        Returns true if the maximum value is being calculated in the supplied set globals entry, false otherwise.
        Parameters:
        entry - the set globals entry
        Returns:
        true if the maximum value is being calculated
      • containsSetGlobalsEntrySDev

        boolean containsSetGlobalsEntrySDev(java.lang.Object entry)
        Returns true if the standard deviation is being calculated in the supplied set globals entry, false otherwise.
        Parameters:
        entry - the set globals entry
        Returns:
        true if the standard deviation is being calculated
      • createRangeBounds

        java.lang.Object createRangeBounds(java.lang.Object minValue,
                                         java.lang.Object maxValue)
        Creates an entry that can be used to specify the desired minimum and maximum of values in a column representing continuous data.
        Parameters:
        minValue - the minimum value
        maxValue - the maximum value
        Returns:
        an entry incorporating the supplied property settings
      • isRangeDefined

        boolean isRangeDefined(java.lang.Object entry)
        Returns true of this range bounds object is fully specified.
        Parameters:
        entry - the range bounds entry
        Returns:
        true of this range bounds object is fully specified
      • getRangeMinValue

        java.lang.Object getRangeMinValue(java.lang.Object entry)
        Returns the lower bound for the supplied range bounds entry or null if the value is unknown.
        Parameters:
        entry - the range bounds entry
        Returns:
        the lower bound
      • getRangeMaxValue

        java.lang.Object getRangeMaxValue(java.lang.Object entry)
        Returns the upper bound for the supplied range bounds entry or null if the value is unknown.
        Parameters:
        entry - the range bounds entry
        Returns:
        the upper bound
      • createFlagEntry

        java.lang.Object createFlagEntry(java.lang.Object trueValue,
                                       java.lang.Object falseValue)
        Creates an entry that can be used to specify the desired true and false values in a column representing a binary indicator.
        Parameters:
        trueValue - the true value
        falseValue - the false value
        Returns:
        an entry incorporating the supplied property settings
      • isFlagDefined

        boolean isFlagDefined(java.lang.Object entry)
        Returns true of this flag entry is fully specified.
        Parameters:
        entry - the flag entry
        Returns:
        true of this flag entry is fully specified
      • getFlagTrueValue

        java.lang.Object getFlagTrueValue(java.lang.Object entry)
        Returns the true value for the supplied flag entry or null if the value is unknown.
        Parameters:
        entry - the flag entry
        Returns:
        the true value
      • getFlagFalseValue

        java.lang.Object getFlagFalseValue(java.lang.Object entry)
        Returns the false value for the supplied flag entry or null if the value is unknown.
        Parameters:
        entry - the flag entry
        Returns:
        the false value
      • createPEVConnection

        java.lang.Object createPEVConnection(java.lang.String description,
                                           java.lang.String applicationView,
                                           java.lang.String versionLabel,
                                           java.lang.String environment,
                                           java.lang.String dataProvider)
        Returns a value suitable for assignment to the IMPORT_PEV_CONNECTION property of a PEV Import Processor.
        Parameters:
        description - a description of the connection
        applicationView - the repository pathname of the application view
        versionLabel - the version label of the application view
        environment - the environment
        dataProvider - the repository pathname of the data provider definition, or null if no DPD has been selected
        Returns:
        a PEV connection object
        Since:
        PSAPI 3.0
      • getPEVConnectionDescription

        java.lang.String getPEVConnectionDescription(java.lang.Object connection)
        Returns the description from a PEV connection object.
        Parameters:
        connection - the PEV connection object
        Returns:
        the description of the connection
        Since:
        PSAPI 3.0
      • getPEVConnectionApplicationView

        java.lang.String getPEVConnectionApplicationView(java.lang.Object connection)
        Returns the application view from a PEV connection object.
        Parameters:
        connection - the PEV connection object
        Returns:
        the application view of the connection
        Since:
        PSAPI 3.0
      • getPEVConnectionVersionLabel

        java.lang.String getPEVConnectionVersionLabel(java.lang.Object connection)
        Returns the version label from a PEV connection object.
        Parameters:
        connection - the PEV connection object
        Returns:
        the version label of the connection
        Since:
        PSAPI 3.0
      • getPEVConnectionEnvironment

        java.lang.String getPEVConnectionEnvironment(java.lang.Object connection)
        Returns the environment from a PEV connection object.
        Parameters:
        connection - the PEV connection object
        Returns:
        the environment of the connection
        Since:
        PSAPI 3.0
      • getPEVConnectionDataProvider

        java.lang.String getPEVConnectionDataProvider(java.lang.Object connection)
        Returns the data provider definition from a PEV connection object or null if the DPD is not set.
        Parameters:
        connection - the PEV connection object
        Returns:
        the DPD of the connection
        Since:
        PSAPI 3.0
      • createDecisionListInteractiveState

        java.lang.Object createDecisionListInteractiveState(java.lang.Object interactorMetadata,
                                                          byte[] viewerMetadata,
                                                          ModelDetail workingModel)
        Creates an interactive state object for a Decision List modelling session suitable for assignment to the DECISION_LIST_INTERACTIVE_STATE property of a model builder.
        Parameters:
        interactorMetadata - metadata from the interactor instance, or null when a state is created for the first time and there is no interactor
        viewerMetadata - metadata from the interactive viewer instance
        workingModel - detail of the working model
        Returns:
        a Decision List interactive state object
        Since:
        PSAPI 3.0
      • getDecisionListInteractiveStateInteractorMetadata

        java.lang.Object getDecisionListInteractiveStateInteractorMetadata(java.lang.Object state)
        Returns the interactor metadata from a Decision List interactive state.
        Parameters:
        state - the interactive state object
        Returns:
        the interactor metadata
        Since:
        PSAPI 3.0
      • getDecisionListInteractiveStateViewerMetadata

        byte[] getDecisionListInteractiveStateViewerMetadata(java.lang.Object state)
        Returns the viewer metadata from a Decision List interactive state.
        Parameters:
        state - the interactive state object
        Returns:
        the viewer metadata
        Since:
        PSAPI 3.0
      • getDecisionListInteractiveStateWorkingModel

        ModelDetail getDecisionListInteractiveStateWorkingModel(java.lang.Object state)
        Returns the working model detail from a Decision List interactive state.
        Parameters:
        state - the interactive state object
        Returns:
        the working model detail
        Since:
        PSAPI 3.0
      • createDefaultStructuredValue

        StructuredValue createDefaultStructuredValue(StructuredPropertyDefinition definition)
        Returns a new structured value using the defaults specified by the structured property definition.
        Parameters:
        definition -
        Returns:
        a new structured value

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.