Package cern.nxcals.api.extraction.metadata

Interface GroupService

  • All Superinterfaces:
    Queryable<Group,​cern.nxcals.api.extraction.metadata.queries.Groups>
    All Known Implementing Classes:
    GroupProvider
    public interface GroupService
extends Queryable<Group,​cern.nxcals.api.extraction.metadata.queries.Groups>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addEntities​(long groupId, java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> entityIdsPerAssociation)
      Attaches the given Map of entities to the given group, by adding the provided entities to the corresponding association.
      void addVariables​(long groupId, java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> variableIdsPerAssociation)
      Attaches the given Map of associations to the given group, by adding the provided variables to the corresponding association.
      Group create​(Group group)
      Creates group as in the parameter NOTE: this is a mutative method.
      void delete​(long groupId)
      Deletes an existing group
      java.util.Map<java.lang.String,​java.util.Set<Entity>> getEntities​(long groupId)
      Returns the complete map of entities grouped by their association to a given group
      java.util.Map<java.lang.String,​java.util.Set<Variable>> getVariables​(long groupId)
      Returns the complete map of variables grouped by their association to a given group
      void removeEntities​(long groupId, java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> entityIdsPerAssociation)
      Detaches the given Map of entities to the given group.
      void removeVariables​(long groupId, java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> variableIdsPerAssociation)
      Detaches the given Map of variables to the given group.
      void setEntities​(long groupId, java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> entityIdsPerAssociation)
      Attaches the given Map of entities to the given group, overwriting any existing associations.
      void setVariables​(long groupId, java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> variableIdsPerAssociation)
      Attaches the given Map of variables to the given group, overwriting any existing associations.
      Group update​(Group group)
      Updates an existing group to the new values as in the parameter NOTE: this is a mutative method.

    • Method Detail

      • create

        Group create​(Group group)
        Creates group as in the parameter NOTE: this is a mutative method. It is not thread-safe or meant to be used in parallel
        Parameters:
        group - to be created
        Returns:
        Created group

      • update

        Group update​(Group group)
        Updates an existing group to the new values as in the parameter NOTE: this is a mutative method. It is not thread-safe or meant to be used in parallel
        Parameters:
        group - to be updated
        Returns:
        Updated group or null if the group does not exist

      • delete

        void delete​(long groupId)
        Deletes an existing group
        Parameters:
        groupId - the id of the group to be deleted

      • getVariables

        java.util.Map<java.lang.String,​java.util.Set<Variable>> getVariables​(long groupId)
        Returns the complete map of variables grouped by their association to a given group
        Parameters:
        groupId - of the group to query
        Returns:
        Map of variables grouped by their association type to the group

      • setVariables

        void setVariables​(long groupId,
                  java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> variableIdsPerAssociation)
        Attaches the given Map of variables to the given group, overwriting any existing associations. In case the association(s) do not exist, it creates and sets the variables as described by their ids. The group and the variables must exist. The map key should represent the association type of the enclosed variable Set. NOTE: this action replaces any existing associations. The resulted associations would reflect the provided context. NOTE: this is a mutative method. It is not thread-safe or meant to be used in parallel
        Parameters:
        groupId - group to attach variables to
        variableIdsPerAssociation - Map of variable ids to attach, grouped by the association type

      • addVariables

        void addVariables​(long groupId,
                  java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> variableIdsPerAssociation)
        Attaches the given Map of associations to the given group, by adding the provided variables to the corresponding association. In case the association(s) do not exist, it creates and adds the variables as described by their ids. The group and the variables to add must exist. The map key should represent the association type of the enclosed variable Set. NOTE: this action only adds to any existing attached Set. Does not fail if variable already present. The resulted associations would reflect the merged product of the existing associations and the provided ones. NOTE: this is a mutative method. It is not thread-safe or meant to be used in parallel
        Parameters:
        groupId - group to attach variables to
        variableIdsPerAssociation - Map of variable ids to attach, grouped by the association type

      • removeVariables

        void removeVariables​(long groupId,
                     java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> variableIdsPerAssociation)
        Detaches the given Map of variables to the given group. The map key should represent the association type of the enclosed variable Set. The group and the variables must exist. NOTE: it removes from any existing attached Set. Does not fail if variable already absent. NOTE: this is a mutative method. It is not thread-safe or meant to be used in parallel
        Parameters:
        groupId - group to attach variables to
        variableIdsPerAssociation - Map of variable ids to detach, grouped by the association type

      • getEntities

        java.util.Map<java.lang.String,​java.util.Set<Entity>> getEntities​(long groupId)
        Returns the complete map of entities grouped by their association to a given group
        Parameters:
        groupId - of the group to query
        Returns:
        Map of entities grouped by their association type to the group

      • setEntities

        void setEntities​(long groupId,
                 java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> entityIdsPerAssociation)
        Attaches the given Map of entities to the given group, overwriting any existing associations. In case the association(s) do not exist, it creates and sets the entities as described by their ids. The group and the entities must exist. The map key should represent the association type of the enclosed entity Set. NOTE: this action replaces any existing associations. The resulted associations would reflect the provided context. NOTE: this is a mutative method. It is not thread-safe or meant to be used in parallel
        Parameters:
        groupId - id of the group to attach entities to
        entityIdsPerAssociation - Map of entity ids to attach, grouped by the association type

      • addEntities

        void addEntities​(long groupId,
                 java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> entityIdsPerAssociation)
        Attaches the given Map of entities to the given group, by adding the provided entities to the corresponding association. In case the association(s) do not exist, it creates and adds the entities as described by their ids. The group and the entities to add must exist. The map key should represent the association type of the enclosed entity Set. NOTE: this action only adds to any existing attached Set. Does not fail if entity already present. The resulted associations would reflect the merged product of the existing associations and the provided ones. NOTE: this is a mutative method. It is not thread-safe or meant to be used in parallel
        Parameters:
        groupId - group to attach entities to
        entityIdsPerAssociation - Map of entity ids to attach, grouped by the association type

      • removeEntities

        void removeEntities​(long groupId,
                    java.util.Map<java.lang.String,​java.util.Set<java.lang.Long>> entityIdsPerAssociation)
        Detaches the given Map of entities to the given group. The map key should represent the association type of the enclosed entity Set. The group and the entities must exist. NOTE: it removes from any existing attached Set. Does not fail if entity already absent. NOTE: this is a mutative method. It is not thread-safe or meant to be used in parallel
        Parameters:
        groupId - group to attach entities to
        entityIdsPerAssociation - Map of entity ids to detach, grouped by the association type