com.nmote.iim4j.dataset.DataSetInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nmote-iim4j Show documentation

IIM4J allows Java programmers to read, write and process IPTC IIM version 4 files.

The newest version!

/*
 * Copyright (c) Nmote Ltd. 2004-2015. All rights reserved.
 * See LICENSE doc in a root of project folder for additional information.
 */

package com.nmote.iim4j.dataset;

import com.nmote.iim4j.serialize.Serializer;

/**
 * DataSetInfo contains meta-information about an instance of IIM DataSet.
 */
public interface DataSetInfo extends Comparable {

	/**
	 * Returns DataSet number.
	 *
	 * @return DataSet number
	 */
	int getDataSetNumber();

	/**
	 * Returns DataSet name.
	 *
	 * @return DataSet name
	 */
	String getName();

	/**
	 * Returns true if DataSet is repeatable.
	 *
	 * @return true if DataSet is repeatable
	 */
	boolean isRepeatable();

	/**
	 * Returns true if DataSet is mandatory.
	 *
	 * @return true if DataSet is mandatory
	 */
	boolean isMandatory();

	/**
	 * Returns serializer for this dataset.
	 *
	 * @return serializer for this dataset
	 */
	Serializer getSerializer();
}