Package cern.nxcals.api.backport.client.service

Interface MetaDataService

  • public interface MetaDataService

    • Method Detail

      • getVariablesOfDataTypeAttachedToHierarchy

        VariableSet getVariablesOfDataTypeAttachedToHierarchy​(Hierarchy hier,
                                                      VariableDataType dataType)
        Gets a set of variables which are in the specified hierarchy and of the specified datatype
        Parameters:
        hier - - Hierarchy to match the variables to. Methods used to extract Hierarchies can be found in this service
        dataType - - VariableDataType to match the variables to. This is represented by an enum which can be found at VariableDataType
        Returns:
        VariableSet - Collection of variables returned

      • getVariablesOfDataTypeWithNameLikePatternAttachedToHierarchy

        VariableSet getVariablesOfDataTypeWithNameLikePatternAttachedToHierarchy​(Hierarchy hier,
                                                                         java.lang.String pattern,
                                                                         VariableDataType dataType)
        Get a set of variables which are in the specified hierarchy and of the specified datatype and have a name which matches the given pattern
        Parameters:
        hier - - Hierarchy to match the variables to. Methods used to extract Hierarchies can be found in this service
        dataType - - VariableDataType to match the variables to. This is represented by an enum which can be found at VariableDataType
        pattern - - String pattern to match the variable name against % = wildcard.
        Returns:
        VariableSet - Collection of variables returned

      • getVariablesOfDataTypeInVariableList

        VariableSet getVariablesOfDataTypeInVariableList​(VariableList variableList,
                                                 VariableDataType dataType)
        Get a set of variables with a given datatype which can found in a variableList
        Parameters:
        variableList - - VariableList object which can be extracted using cern.accsoft.backport.extr.domain.client.QuerySnapshotDataService
        dataType - - VariableDataType to match the variables to. This is represented by an enum which can be found at VariableDataType
        Returns:
        VariableSet - Collection of variables returned

      • getFundamentalsInTimeWindowWithNameLikePattern

        VariableSet getFundamentalsInTimeWindowWithNameLikePattern​(java.sql.Timestamp startTime,
                                                           java.sql.Timestamp endTime,
                                                           java.lang.String pattern)
        Gets a variableSet containing all fundamentals which can be found in the given time window with a name which matched the pattern
        Parameters:
        startTime - - Start of the required time window represented by a Java Timestamp object which can be created by Timestamp startTime = Timestamp.valueOf("2012-01-01 12:00:00"); Note this should represent the local time.
        endTime - - End of the required time window represented by a Java Timestamp object. NOTE the format must be the JDBC escape format: yyyy-mm-dd hh:mm:ss
        pattern - - String pattern to match the variable name against % = wildcard.
        Returns:
        VariableSet - Collection of variables returned

      • getVariablesOfDataTypeWithNameLikePattern

        VariableSet getVariablesOfDataTypeWithNameLikePattern​(java.lang.String pattern,
                                                      VariableDataType dataType)
        Get set of variables of the given datatype with a name which matches the given pattern
        Parameters:
        pattern - - String pattern to match the variable name against % = wildcard.
        dataType - - VariableDataType to match the variables to. This is represented by an enum which can be found at VariableDataType
        Returns:
        VariableSet - Collection of variables returned

      • getVariablesWithNameInListofStrings

        VariableSet getVariablesWithNameInListofStrings​(java.util.List<java.lang.String> variableNames)
        Get a set of variables whose names are in the list of strings given
        Parameters:
        variableNames - - List of strings to use to find variables
        Returns:
        VariableSet - Collection of variables returned

      • getVectorElementsInTimeWindow

        VectornumericElementsSet getVectorElementsInTimeWindow​(Variable variable,
                                                       java.sql.Timestamp minStamp,
                                                       java.sql.Timestamp maxStamp)
        Parameters:
        variable -
        minStamp -
        maxStamp -
        Returns:

      • getAllHierarchies

        HierarchySet getAllHierarchies()
        Gets a HierarchySet containing all available Hierarchy objects
        Returns:
        HierarchySet - Collection of hierarchies

      • getHierarchyChildNodes

        HierarchySet getHierarchyChildNodes​(Hierarchy parentHier)
        Gets a HierarchySet containing all available Hierarchy objects which are children of the given Hierarchy.
        Parameters:
        parentHier - - Hierarchy object representing the parent hierarchy for which to get children. This can be extracted using this service.
        Returns:
        HierarchySet - Collection of hierarchies

      • getHierarchyForNodePath

        Hierarchy getHierarchyForNodePath​(java.lang.String nodePath)
        Gets a Hierarchy node which has the given node path. The elements of the node path should be separated by '->' For example, to find a hierarchy node corresponding to 'Beam Intensity Monitors' attached to the node 'Primary Beam' of the Top Level node 'CNGS', use a nodePath value of 'CNGS->Primary Beam->Beam Intensity Monitors'. To get a Hierarchy node corresponding to the Top Level node 'CNGS', just use a nodePath value of 'CNGS'. NOTE: The quotes ' should not be included in the nodePath string.
        Parameters:
        nodePath - - String node path to get hierarchy for
        Returns:
        Hierarchy - Single hierarchy object

      • getTopLevelHierarchies

        HierarchySet getTopLevelHierarchies()
        Gets a HierarchySet containing all Hierarchy objects which are parents of the ROOT hierarchy
        Returns:
        HierarchySet - Collection of hierarchies

      • getHierarchiesForVariable

        HierarchySet getHierarchiesForVariable​(Variable variable)
        Gets a set of all hierarchies which the given variable can be found within
        Parameters:
        variable - - Variable object to get hierarchies for can be extracted using this service
        Returns:
        HierarchySet - Collection of hierarchies

      • getJapcParameterDefinitionForDeviceAndPropertyName

        JapcParameterDefinition getJapcParameterDefinitionForDeviceAndPropertyName​(java.lang.String deviceName,
                                                                           java.lang.String propertyName)
        Gets an JapcParameterDefinition object representing a JAPC parameter with a device name and property name which match the given Strings. This object is required to retrieve AcquiredParameterValue objects from the database using the AcquiredParameterValuesServiceImpl
        Parameters:
        deviceName - - the device name for which to retrieve a JAPC parameter.
        propertyName - - the property name for which to retrieve a JAPC parameter.
        Returns:
        - JapcParameterDefinition (the JAPC parameter representation - required in order to retrieve AcquiredParameterValues using the AcquiredParameterValuesServiceImpl)

      • getVariablesOfDataTypeWithNameLikePatternInVariableList

        VariableSet getVariablesOfDataTypeWithNameLikePatternInVariableList​(VariableList variableList,
                                                                    java.lang.String pattern,
                                                                    VariableDataType dataType)
        Get set of variables of the given datatype with a name which matches the given pattern which can be found in the given variable list.
        Parameters:
        variableList - - VariableList object which can be extracted using cern.accsoft.backport.extr.domain.client.QuerySnapshotDataService
        pattern - - String pattern to match the variable name against % = wildcard.
        dataType - - VariableDataType to match the variables to. This is represented by an enum which can be found at VariableDataType
        Returns:
        VariableSet - Collection of variables returned

      • getAllDeviceNames

        java.util.List<java.lang.String> getAllDeviceNames()

      • getPropertyNamesForDeviceName

        java.util.List<java.lang.String> getPropertyNamesForDeviceName​(java.lang.String deviceName)

      • getJapcDefinitionFor

        java.util.Collection<SimpleJapcParameter> getJapcDefinitionFor​(VariableList variableList)
        Gets a collection of japc configuration for the given variable list
        Parameters:
        variableList - - the given variable list
        Returns:
        a collection of japc configuration objects