vtkMRMLTableStorageNode.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

  Portions (c) Copyright 2015 Brigham and Women's Hospital (BWH) All Rights Reserved.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Andras Lasso (PerkLab, Queen's
  University) and Kevin Wang (Princess Margaret Hospital, Toronto) and was
  supported through OCAIRO and the Applied Cancer Research Unit program of
  Cancer Care Ontario.

==============================================================================*/

#ifndef __vtkMRMLTableStorageNode_h
#define __vtkMRMLTableStorageNode_h

#include "vtkMRMLStorageNode.h"

class vtkMRMLTableNode;
class vtkTable;

class VTK_MRML_EXPORT vtkMRMLTableStorageNode : public vtkMRMLStorageNode
{
public:
  static vtkMRMLTableStorageNode *New();
  vtkTypeMacro(vtkMRMLTableStorageNode,vtkMRMLStorageNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMRMLNode* CreateNodeInstance() override;

  const char* GetNodeTagName() override {return "TableStorage";}

  bool CanReadInReferenceNode(vtkMRMLNode *refNode) override;

  virtual void SetSchemaFileName(const char* schemaFileName);
  virtual std::string GetSchemaFileName();

  std::string FindSchemaFileName(const char* fileName);

  vtkSetMacro(AutoFindSchema, bool);
  vtkGetMacro(AutoFindSchema, bool);
  vtkBooleanMacro(AutoFindSchema, bool);

protected:
  vtkMRMLTableStorageNode();
  ~vtkMRMLTableStorageNode() override;
  vtkMRMLTableStorageNode(const vtkMRMLTableStorageNode&);
  void operator=(const vtkMRMLTableStorageNode&);

  void InitializeSupportedReadFileTypes() override;

  void InitializeSupportedWriteFileTypes() override;

  int ReadDataInternal(vtkMRMLNode *refNode) override;

  int WriteDataInternal(vtkMRMLNode *refNode) override;

  std::string GenerateSchemaFileName(const char* fileName);

  virtual std::string GetFieldDelimiterCharacters(std::string filename);

  // Struct for managing column information
  struct StructColumnInfo
  {
    std::string ColumnName;
    std::vector<vtkAbstractArray*> RawComponentArrays;
    int ScalarType = VTK_STRING;
    std::vector<std::string> ComponentNames;
    std::string NullValueString;
  };
  using ColumnInfo = struct StructColumnInfo;

  std::vector<ColumnInfo> GetColumnInfo(vtkMRMLTableNode* tableNode, vtkTable* rawTable);

  void FillDataFromStringArray(vtkStringArray* stringComponentArray, vtkDataArray* dataArray, std::string nullValueString="");

  void AddColumnToTable(vtkTable* table, ColumnInfo columnInfo);

  bool ReadSchema(std::string filename, vtkMRMLTableNode* tableNode);
  bool ReadTable(std::string filename, vtkMRMLTableNode* tableNode);

  bool WriteTable(std::string filename, vtkMRMLTableNode* tableNode);
  bool WriteSchema(std::string filename, vtkMRMLTableNode* tableNode);

  bool AutoFindSchema;
};

#endif