Class SignalDefinitionBuilder


  • public class SignalDefinitionBuilder
    extends java.lang.Object
    A builder that constructs a signal definition A signal definition provides everything needed for NEON Signal Mapper to display signal information on Android and Neon Command, display signal measurements and heatmaps, and export reports The Signal Key uniquely identifies a signal Identifier Definitions are pieces of information that identify a particular signal source and can be used to separate individual signal types Heatmap Definitions describe measurements that can be displayed in a heatmap and viewed as colored signal dots Display Definitions are additional pieces of information that are displayed with a particular signal measurement
    • Constructor Summary

      Constructors 
      Constructor Description
      SignalDefinitionBuilder​(java.lang.String provider, java.lang.String technology, java.lang.String signal)
      A set of strings that identify this signal
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SignalDefinitionBuilder AddDisplayDefinition​(java.lang.String fieldName, java.lang.String displayName, java.lang.String displayFormat, java.lang.String exportFormat, DisplayType displayType, int sortIndex)
      Add a display value to this signal
      SignalDefinitionBuilder AddHeatmapDefinition​(java.lang.String fieldName, java.lang.String displayName, java.lang.String displayFormat, java.lang.String exportFormat, java.lang.String units, float min, float max, float threshold, boolean locateSources, int sortIndex)
      Add a heatmap value to this signal.
      SignalDefinitionBuilder AddIdentifierDefinition​(java.lang.String fieldName, java.lang.String displayName, java.lang.String displayFormat, java.lang.String exportFormat, boolean separateExportFiles, DisplayType displayType, int sortIndex)
      Add an identifier to this signal
      SignalDefinition Build()
      Build the signal definition
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SignalDefinitionBuilder

        public SignalDefinitionBuilder​(java.lang.String provider,
                                       java.lang.String technology,
                                       java.lang.String signal)
        A set of strings that identify this signal
        See Also:
        SignalKey
    • Method Detail

      • AddHeatmapDefinition

        public SignalDefinitionBuilder AddHeatmapDefinition​(java.lang.String fieldName,
                                                            java.lang.String displayName,
                                                            java.lang.String displayFormat,
                                                            java.lang.String exportFormat,
                                                            java.lang.String units,
                                                            float min,
                                                            float max,
                                                            float threshold,
                                                            boolean locateSources,
                                                            int sortIndex)
        Add a heatmap value to this signal. There should be at least one of these in each signal
        Parameters:
        fieldName - The name of this value, which should be unique in the signal, such as "ChannelPower"
        displayName - The string to use when displaying this signal in NEON Signal Mapper and Command, such as "Channel Power"
        displayFormat - A Java-style format string for display purposes - for instance "%.2f dBm" to display a dBm measurement to two decimal places (-76.25 dBm)
        exportFormat - A Java-style format string for CSV export purposes - for instance "%.2f" to display a dBm measurement to two decimal places (-76.25)
        units - The unit of measurement, "dBm" for example
        min - The minimum value that this measurement will contain
        max - The maximum value that this measurement will contain
        threshold - A threshold value between min and max that can be used as a default level to define a "good" signal for grid testing
        locateSources - If set to true, NEON Command will attempt to use heatmaps to localize the source of this signal. This should only be used for local sources such as iBeacons or Wi-Fi access points for good results.
        sortIndex - Indicates where this value should be listed relative to other details of the signal
        Returns:
        the signaldefinitionbuilder
        See Also:
        HeatmapDefinition
      • AddIdentifierDefinition

        public SignalDefinitionBuilder AddIdentifierDefinition​(java.lang.String fieldName,
                                                               java.lang.String displayName,
                                                               java.lang.String displayFormat,
                                                               java.lang.String exportFormat,
                                                               boolean separateExportFiles,
                                                               DisplayType displayType,
                                                               int sortIndex)
        Add an identifier to this signal
        Parameters:
        fieldName - The name of this value, which should be unique in the signal, such as "ChannelPower"
        displayName - The string to use when displaying this signal in NEON Signal Mapper and Command, such as "Channel Power"
        displayFormat - A Java-style format string for display purposes - for instance "%.2f dBm" to display a dBm measurement to two decimal places (-76.25 dBm)
        exportFormat - A Java-style format string for CSV export purposes - for instance "%.2f" to display a dBm measurement to two decimal places (-76.25)
        separateExportFiles - If set to true, CSV export files from command will be separated based on this identifier. For instance, if there is a channel index as an identifier than each channel index present will get a separate CSV file
        displayType - The field type of this identifer - currently String, Integer, or Float. This type must match with the format display and export format strings.
        sortIndex - Indicates where this value should be listed relative to other details of the signal
        Returns:
        the signaldefinitionbuilder
        See Also:
        IdentifierDefinition
      • AddDisplayDefinition

        public SignalDefinitionBuilder AddDisplayDefinition​(java.lang.String fieldName,
                                                            java.lang.String displayName,
                                                            java.lang.String displayFormat,
                                                            java.lang.String exportFormat,
                                                            DisplayType displayType,
                                                            int sortIndex)
        Add a display value to this signal
        Parameters:
        fieldName - The name of this value, which should be unique in the signal, such as "ChannelPower"
        displayName - The string to use when displaying this signal in NEON Signal Mapper and Command, such as "Channel Power"
        displayFormat - A Java-style format string for display purposes - for instance "%.2f dBm" to display a dBm measurement to two decimal places (-76.25 dBm)
        exportFormat - A Java-style format string for CSV export purposes - for instance "%.2f" to display a dBm measurement to two decimal places (-76.25)
        displayType - The field type of this display value - currently String, Integer, or Float. This type must match with the format display and export format strings.
        sortIndex - Indicates where this value should be listed relative to other details of the signal
        Returns:
        the signaldefinitionbuilder
        See Also:
        DisplayDefinition
      • Build

        public SignalDefinition Build()
        Build the signal definition
        Returns:
        A complete signal definition