org.eclipse.dawnsci.nexus.validation.NXtasValidator Maven / Gradle / Ivy

/*-
 *******************************************************************************
 * Copyright (c) 2015 Diamond Light Source Ltd.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * This file was auto-generated from the NXDL XML definition.
 *******************************************************************************/

package org.eclipse.dawnsci.nexus.validation;
import static org.eclipse.dawnsci.nexus.validation.NexusDataType.NX_CHAR;
import static org.eclipse.dawnsci.nexus.validation.NexusDataType.NX_DATE_TIME;
import static org.eclipse.dawnsci.nexus.validation.NexusDataType.NX_FLOAT;
import static org.eclipse.dawnsci.nexus.validation.NexusDataType.NX_INT;
import static org.eclipse.dawnsci.nexus.validation.NexusUnitCategory.NX_ANGLE;
import static org.eclipse.dawnsci.nexus.validation.NexusUnitCategory.NX_ANY;
import static org.eclipse.dawnsci.nexus.validation.NexusUnitCategory.NX_DIMENSIONLESS;
import static org.eclipse.dawnsci.nexus.validation.NexusUnitCategory.NX_ENERGY;
import static org.eclipse.dawnsci.nexus.validation.NexusUnitCategory.NX_LENGTH;

import java.util.Map;

import org.eclipse.dawnsci.nexus.NXcrystal;
import org.eclipse.dawnsci.nexus.NXdata;
import org.eclipse.dawnsci.nexus.NXdetector;
import org.eclipse.dawnsci.nexus.NXentry;
import org.eclipse.dawnsci.nexus.NXinstrument;
import org.eclipse.dawnsci.nexus.NXmonitor;
import org.eclipse.dawnsci.nexus.NXroot;
import org.eclipse.dawnsci.nexus.NXsample;
import org.eclipse.dawnsci.nexus.NXsource;
import org.eclipse.dawnsci.nexus.NXsubentry;
import org.eclipse.january.dataset.IDataset;

/**
 * Validator for the application definition 'NXtas'.
 */
public class NXtasValidator extends AbstractNexusValidator implements NexusApplicationValidator {

	@Override
	public void validate(NXroot root) throws NexusValidationException {
		// validate child group 'entry' of type NXentry
		validateGroup_entry(root.getEntry());
	}

	@Override
	public void validate(NXentry entry) throws NexusValidationException {
		validateGroup_entry(entry);
	}

	@Override
	public void validate(NXsubentry subentry) throws NexusValidationException {
		validateGroup_entry(subentry);
	}


	/**
	 * Validate group 'entry' of type NXentry.
	 */
	private void validateGroup_entry(final NXsubentry group) throws NexusValidationException {
		// validate that the group is not null
		validateGroupNotNull("entry", NXentry.class, group);

		// validate field 'title' of type NX_CHAR.
		final IDataset title = group.getTitle();
		validateFieldNotNull("title", title);
		validateFieldType("title", title, NX_CHAR);

		// validate field 'start_time' of type NX_DATE_TIME.
		final IDataset start_time = group.getStart_time();
		validateFieldNotNull("start_time", start_time);
		validateFieldType("start_time", start_time, NX_DATE_TIME);

		// validate field 'definition' of unknown type.
		final IDataset definition = group.getDefinition();
		validateFieldNotNull("definition", definition);
		validateFieldEnumeration("definition", definition,
				"NXtas");

		// validate unnamed child group of type NXinstrument (possibly multiple)
		final Map allInstrument = group.getAllInstrument();
		for (final NXinstrument instrument : allInstrument.values()) {
			validateGroup_entry_NXinstrument(instrument);
		}

		// validate unnamed child group of type NXsample (possibly multiple)
		final Map allSample = group.getAllSample();
		for (final NXsample sample : allSample.values()) {
			validateGroup_entry_NXsample(sample);
		}

		// validate unnamed child group of type NXmonitor (possibly multiple)
		final Map allMonitor = group.getAllMonitor();
		for (final NXmonitor monitor : allMonitor.values()) {
			validateGroup_entry_NXmonitor(monitor);
		}

		// validate unnamed child group of type NXdata (possibly multiple)
		final Map allData = group.getAllData();
		for (final NXdata data : allData.values()) {
			validateGroup_entry_NXdata(data);
		}
	}

	/**
	 * Validate unnamed group of type NXinstrument.
	 */
	private void validateGroup_entry_NXinstrument(final NXinstrument group) throws NexusValidationException {
		// validate that the group is not null
		validateGroupNotNull(null, NXinstrument.class, group);

		// validate unnamed child group of type NXsource (possibly multiple)
		final Map allSource = group.getAllSource();
		for (final NXsource source : allSource.values()) {
			validateGroup_entry_NXinstrument_NXsource(source);
		}

		// validate child group 'monochromator' of type NXcrystal
		validateGroup_entry_NXinstrument_monochromator(group.getCrystal());

		// validate child group 'analyser' of type NXcrystal
		validateGroup_entry_NXinstrument_analyser(group.getCrystal());

		// validate unnamed child group of type NXdetector (possibly multiple)
		final Map allDetector = group.getAllDetector();
		for (final NXdetector detector : allDetector.values()) {
			validateGroup_entry_NXinstrument_NXdetector(detector);
		}
	}

	/**
	 * Validate unnamed group of type NXsource.
	 */
	private void validateGroup_entry_NXinstrument_NXsource(final NXsource group) throws NexusValidationException {
		// validate that the group is not null
		validateGroupNotNull(null, NXsource.class, group);

		// validate field 'name' of unknown type.
		final IDataset name = group.getName();
		validateFieldNotNull("name", name);

		// validate field 'probe' of unknown type.
		final IDataset probe = group.getProbe();
		validateFieldNotNull("probe", probe);
		validateFieldEnumeration("probe", probe,
				"neutron",
				"x-ray");
	}

	/**
	 * Validate group 'monochromator' of type NXcrystal.
	 */
	private void validateGroup_entry_NXinstrument_monochromator(final NXcrystal group) throws NexusValidationException {
		// validate that the group is not null
		validateGroupNotNull("monochromator", NXcrystal.class, group);
		clearLocalGroupDimensionPlaceholderValues();

		// validate field 'ei' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset ei = group.getDataset("ei");
		validateFieldNotNull("ei", ei);
		validateFieldType("ei", ei, NX_FLOAT);
		validateFieldUnits("ei", ei, NX_ENERGY);
		validateFieldRank("ei", ei, 1);
		validateFieldDimensions("ei", ei, null, "np");

		// validate field 'rotation_angle' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset rotation_angle = group.getDataset("rotation_angle");
		validateFieldNotNull("rotation_angle", rotation_angle);
		validateFieldType("rotation_angle", rotation_angle, NX_FLOAT);
		validateFieldUnits("rotation_angle", rotation_angle, NX_ANGLE);
		validateFieldRank("rotation_angle", rotation_angle, 1);
		validateFieldDimensions("rotation_angle", rotation_angle, null, "np");
	}

	/**
	 * Validate group 'analyser' of type NXcrystal.
	 */
	private void validateGroup_entry_NXinstrument_analyser(final NXcrystal group) throws NexusValidationException {
		// validate that the group is not null
		validateGroupNotNull("analyser", NXcrystal.class, group);
		clearLocalGroupDimensionPlaceholderValues();

		// validate field 'ef' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset ef = group.getDataset("ef");
		validateFieldNotNull("ef", ef);
		validateFieldType("ef", ef, NX_FLOAT);
		validateFieldUnits("ef", ef, NX_ENERGY);
		validateFieldRank("ef", ef, 1);
		validateFieldDimensions("ef", ef, null, "np");

		// validate field 'rotation_angle' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset rotation_angle = group.getDataset("rotation_angle");
		validateFieldNotNull("rotation_angle", rotation_angle);
		validateFieldType("rotation_angle", rotation_angle, NX_FLOAT);
		validateFieldUnits("rotation_angle", rotation_angle, NX_ANGLE);
		validateFieldRank("rotation_angle", rotation_angle, 1);
		validateFieldDimensions("rotation_angle", rotation_angle, null, "np");

		// validate field 'polar_angle' of type NX_FLOAT.
		final IDataset polar_angle = group.getPolar_angle();
		validateFieldNotNull("polar_angle", polar_angle);
		validateFieldType("polar_angle", polar_angle, NX_FLOAT);
		validateFieldUnits("polar_angle", polar_angle, NX_ANGLE);
		validateFieldRank("polar_angle", polar_angle, 1);
		validateFieldDimensions("polar_angle", polar_angle, null, "np");
	}

	/**
	 * Validate unnamed group of type NXdetector.
	 */
	private void validateGroup_entry_NXinstrument_NXdetector(final NXdetector group) throws NexusValidationException {
		// validate that the group is not null
		validateGroupNotNull(null, NXdetector.class, group);
		clearLocalGroupDimensionPlaceholderValues();

		// validate field 'data' of type NX_INT.
		final IDataset data = group.getData();
		validateFieldNotNull("data", data);
		validateFieldType("data", data, NX_INT);
		validateFieldUnits("data", data, NX_ANY);
		validateFieldRank("data", data, 1);
		validateFieldDimensions("data", data, null, "np");

		// validate field 'polar_angle' of type NX_FLOAT.
		final IDataset polar_angle = group.getPolar_angle();
		validateFieldNotNull("polar_angle", polar_angle);
		validateFieldType("polar_angle", polar_angle, NX_FLOAT);
		validateFieldUnits("polar_angle", polar_angle, NX_ANGLE);
		validateFieldRank("polar_angle", polar_angle, 1);
		validateFieldDimensions("polar_angle", polar_angle, null, "np");
	}

	/**
	 * Validate unnamed group of type NXsample.
	 */
	private void validateGroup_entry_NXsample(final NXsample group) throws NexusValidationException {
		// validate that the group is not null
		validateGroupNotNull(null, NXsample.class, group);
		clearLocalGroupDimensionPlaceholderValues();

		// validate field 'name' of unknown type.
		final IDataset name = group.getName();
		validateFieldNotNull("name", name);

		// validate field 'qh' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset qh = group.getDataset("qh");
		validateFieldNotNull("qh", qh);
		validateFieldType("qh", qh, NX_FLOAT);
		validateFieldUnits("qh", qh, NX_DIMENSIONLESS);
		validateFieldRank("qh", qh, 1);
		validateFieldDimensions("qh", qh, null, "np");

		// validate field 'qk' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset qk = group.getDataset("qk");
		validateFieldNotNull("qk", qk);
		validateFieldType("qk", qk, NX_FLOAT);
		validateFieldUnits("qk", qk, NX_DIMENSIONLESS);
		validateFieldRank("qk", qk, 1);
		validateFieldDimensions("qk", qk, null, "np");

		// validate field 'ql' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset ql = group.getDataset("ql");
		validateFieldNotNull("ql", ql);
		validateFieldType("ql", ql, NX_FLOAT);
		validateFieldUnits("ql", ql, NX_DIMENSIONLESS);
		validateFieldRank("ql", ql, 1);
		validateFieldDimensions("ql", ql, null, "np");

		// validate field 'en' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset en = group.getDataset("en");
		validateFieldNotNull("en", en);
		validateFieldType("en", en, NX_FLOAT);
		validateFieldUnits("en", en, NX_ENERGY);
		validateFieldRank("en", en, 1);
		validateFieldDimensions("en", en, null, "np");

		// validate field 'rotation_angle' of type NX_FLOAT.
		final IDataset rotation_angle = group.getRotation_angle();
		validateFieldNotNull("rotation_angle", rotation_angle);
		validateFieldType("rotation_angle", rotation_angle, NX_FLOAT);
		validateFieldUnits("rotation_angle", rotation_angle, NX_ANGLE);
		validateFieldRank("rotation_angle", rotation_angle, 1);
		validateFieldDimensions("rotation_angle", rotation_angle, null, "np");

		// validate field 'polar_angle' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset polar_angle = group.getDataset("polar_angle");
		validateFieldNotNull("polar_angle", polar_angle);
		validateFieldType("polar_angle", polar_angle, NX_FLOAT);
		validateFieldUnits("polar_angle", polar_angle, NX_ANGLE);
		validateFieldRank("polar_angle", polar_angle, 1);
		validateFieldDimensions("polar_angle", polar_angle, null, "np");

		// validate field 'sgu' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset sgu = group.getDataset("sgu");
		validateFieldNotNull("sgu", sgu);
		validateFieldType("sgu", sgu, NX_FLOAT);
		validateFieldUnits("sgu", sgu, NX_ANGLE);
		validateFieldRank("sgu", sgu, 1);
		validateFieldDimensions("sgu", sgu, null, "np");

		// validate field 'sgl' of type NX_FLOAT. Note: field not defined in base class.
		final IDataset sgl = group.getDataset("sgl");
		validateFieldNotNull("sgl", sgl);
		validateFieldType("sgl", sgl, NX_FLOAT);
		validateFieldUnits("sgl", sgl, NX_ANGLE);
		validateFieldRank("sgl", sgl, 1);
		validateFieldDimensions("sgl", sgl, null, "np");

		// validate field 'unit_cell' of type NX_FLOAT.
		final IDataset unit_cell = group.getUnit_cell();
		validateFieldNotNull("unit_cell", unit_cell);
		validateFieldType("unit_cell", unit_cell, NX_FLOAT);
		validateFieldUnits("unit_cell", unit_cell, NX_LENGTH);
		validateFieldRank("unit_cell", unit_cell, 1);
		validateFieldDimensions("unit_cell", unit_cell, null, 6);

		// validate field 'orientation_matrix' of type NX_FLOAT.
		final IDataset orientation_matrix = group.getOrientation_matrix();
		validateFieldNotNull("orientation_matrix", orientation_matrix);
		validateFieldType("orientation_matrix", orientation_matrix, NX_FLOAT);
		validateFieldUnits("orientation_matrix", orientation_matrix, NX_DIMENSIONLESS);
		validateFieldRank("orientation_matrix", orientation_matrix, 1);
		validateFieldDimensions("orientation_matrix", orientation_matrix, null, 9);
	}

	/**
	 * Validate unnamed group of type NXmonitor.
	 */
	private void validateGroup_entry_NXmonitor(final NXmonitor group) throws NexusValidationException {
		// validate that the group is not null
		validateGroupNotNull(null, NXmonitor.class, group);
		clearLocalGroupDimensionPlaceholderValues();

		// validate field 'mode' of unknown type.
		final IDataset mode = group.getMode();
		validateFieldNotNull("mode", mode);
		validateFieldEnumeration("mode", mode,
				"monitor",
				"timer");

		// validate field 'preset' of type NX_FLOAT.
		final IDataset preset = group.getPreset();
		validateFieldNotNull("preset", preset);
		validateFieldType("preset", preset, NX_FLOAT);
		validateFieldUnits("preset", preset, NX_ANY);

		// validate field 'data' of type NX_FLOAT.
		final IDataset data = group.getData();
		validateFieldNotNull("data", data);
		validateFieldType("data", data, NX_FLOAT);
		validateFieldUnits("data", data, NX_ANY);
		validateFieldRank("data", data, 1);
		validateFieldDimensions("data", data, null, "np");
	}

	/**
	 * Validate unnamed group of type NXdata.
	 */
	private void validateGroup_entry_NXdata(final NXdata group) throws NexusValidationException {
		// validate that the group is not null
		validateGroupNotNull(null, NXdata.class, group);
		clearLocalGroupDimensionPlaceholderValues();

	}
}