AnnotationBuilder

Source

index.js

import { generateUUID } from 'paraviewweb/src/Common/Misc/UUID';
import SelectionBuilder from 'paraviewweb/src/Common/Misc/SelectionBuilder';

// ----------------------------------------------------------------------------
// Internal helpers
// ----------------------------------------------------------------------------

let generation = 0;

function setInitialGenerationNumber(genNum) {
  generation = genNum;
}

// ----------------------------------------------------------------------------
// Public builder method
// ----------------------------------------------------------------------------

function annotation(selection, score, weight = 1, rationale = '', name = '') {
  generation += 1;
  return {
    id: generateUUID(),
    generation,
    selection,
    score,
    weight,
    rationale,
    name,
  };
}

// ----------------------------------------------------------------------------

function update(annotationObject, changeSet) {
  const updatedAnnotation = Object.assign({}, annotationObject, changeSet);

  let changeDetected = false;
  Object.keys(updatedAnnotation).forEach((key) => {
    if (updatedAnnotation[key] !== annotationObject[key]) {
      changeDetected = true;
    }
  });

  if (changeDetected) {
    generation += 1;
    updatedAnnotation.generation = generation;
  }

  return updatedAnnotation;
}

// ----------------------------------------------------------------------------

function updateReadOnlyFlag(annotationToEdit, readOnlyFields) {
  if (!annotationToEdit || !annotationToEdit.selection || !readOnlyFields) {
    return;
  }

  annotationToEdit.readOnly = SelectionBuilder.hasField(
    annotationToEdit.selection,
    readOnlyFields
  );
}

// ----------------------------------------------------------------------------

function fork(annotationObj) {
  const id = generateUUID();
  generation += 1;
  return Object.assign({}, annotationObj, { generation, id });
}

function setDefaultName(annotationObject) {
  if (annotationObject.selection.type === 'range') {
    const rangeNames = Object.keys(annotationObject.selection.range.variables);
    if (rangeNames.length > 0) {
      annotationObject.name = rangeNames[0];
      if (rangeNames.length > 1) {
        annotationObject.name += ` & ${rangeNames[1]}`;
      }
      if (rangeNames.length > 2) {
        annotationObject.name += ' &...';
      }
    } else {
      annotationObject.name = 'empty';
    }
    annotationObject.name += ' (range)';
  } else if (annotationObject.selection.type === 'partition') {
    annotationObject.name = `${annotationObject.selection.partition.variable} (partition)`;
  } else {
    annotationObject.name = 'unknown';
  }
}

// ----------------------------------------------------------------------------

function markModified(annotationObject) {
  generation += 1;
  return Object.assign({}, annotationObject, { generation });
}

// ----------------------------------------------------------------------------
// Exposed object
// ----------------------------------------------------------------------------

const EMPTY_ANNOTATION = annotation(SelectionBuilder.EMPTY_SELECTION, []);

export default {
  annotation,
  EMPTY_ANNOTATION,
  fork,
  markModified,
  setDefaultName,
  setInitialGenerationNumber,
  update,
  updateReadOnlyFlag,
};