com.okworx.ilcd.validation.IDatasetsValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ilcd-validation Show documentation

A Java library for performing technical validation of data in ILCD data format.

There is a newer version: 2.7.2

package com.okworx.ilcd.validation;

import java.io.File;
import java.util.HashMap;

import com.okworx.ilcd.validation.profile.Profile;
import com.okworx.ilcd.validation.reference.IDatasetReference;
import com.okworx.ilcd.validation.util.IUpdateEventListener;
import com.okworx.ilcd.validation.util.Statistics;

/**
 * IDatasetsValidator interface.
 *
 * @author oliver.kusche
 * @version $Id: $Id
 */
public interface IDatasetsValidator extends IValidator {

	/**
	 * setObjectsToValidate.
	 *
	 * @param objects a {@link java.util.HashMap} object.
	 */
	public abstract void setObjectsToValidate(HashMap objects);

	/**
	 * setObjectsToValidate.
	 *
	 * @param directory a {@link java.io.File} object.
	 */
	public abstract void setObjectsToValidate(File directory);

	/**
	 * getObjectsToValidate.
	 *
	 * @return a {@link java.util.HashMap} object.
	 */
	public abstract HashMap getObjectsToValidate();

	/**
	 * setProfile.
	 *
	 * @param profile a {@link com.okworx.ilcd.validation.profile.Profile} object.
	 */
	public abstract void setProfile(Profile profile);

	/**
	 * getProfile.
	 *
	 * @return a {@link com.okworx.ilcd.validation.profile.Profile} object.
	 */
	public abstract Profile getProfile();

	/**
	 * validate.
	 *
	 * @return a boolean.
	 * @throws java.lang.InterruptedException if any.
	 */
	public abstract boolean validate() throws InterruptedException;

	/**
	 * getUpdateEventListener.
	 *
	 * @return a {@link com.okworx.ilcd.validation.util.IUpdateEventListener} object.
	 */
	public IUpdateEventListener getUpdateEventListener();

	/**
	 * setUpdateEventListener.
	 *
	 * @param listener a {@link com.okworx.ilcd.validation.util.IUpdateEventListener} object.
	 */
	public void setUpdateEventListener(IUpdateEventListener listener);

	/**
	 * setUpdateInterval.
	 *
	 * @param updateInterval a int.
	 */
	public abstract void setUpdateInterval(int updateInterval);

	/**
	 * setValidateArchives.
	 *
	 * @param validateArchives a boolean.
	 */
	public abstract void setValidateArchives(boolean validateArchives);
	
	/**
	 * getStatistics.
	 *
	 * @return a {@link com.okworx.ilcd.validation.util.Statistics} object.
	 */
	public Statistics getStatistics();

	/**
	 * getFileSource.
	 *
	 * @return a File object for the original file (ZIP/folder/XML) if a single file has been handed over for validation.
	 */
	public File getFileSource();


}