/**
 * Copyright (C) [2013] [The FURTHeR Project]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 */
package edu.utah.further.core.util.io;

import edu.utah.further.core.api.context.Api;
import edu.utah.further.core.api.context.Labeled;

/**
 * Centralizes recognized database types.
 * <p>
 * -----------------------------------------------------------------------------------<br>
 * (c) 2008-2013 FURTHeR Project, Health Sciences IT, University of Utah<br>
 * Contact: {@code <further@utah.edu>}<br>
 * Biomedical Informatics, 26 South 2000 East<br>
 * Room 5775 HSEB, Salt Lake City, UT 84112<br>
 * Day Phone: 1-801-581-4080<br>
 * -----------------------------------------------------------------------------------
 *
 * @author Oren E. Livne {@code <oren.livne@utah.edu>}
 * @version Feb 3, 2011
 */
@Api
public enum DataSourceType implements Labeled
{
	// ========================= ENUMERATED CONSTANTS ======================

	/**
	 * Hypersonic in-memory database.
	 */
	hsqldb("HSQLDB"),

	/**
	 * MySQL server.
	 */
	mysql("MySQL"),

	/**
	 * MySQL server.
	 */
	oracle("Oracle"),

	/**
	 * MySQL server.
	 */
	sql("Microsoft SQL Server"),

	/**
	 * MySQL server.
	 */
	postgre("PostgreSQL"),

	/**
	 * An unrecognized server.
	 */
	other("Other");

	// ========================= FIELDS =======================================

	/**
	 * Data source type display name.
	 */
	private final String label;

	// ========================= CONSTRUCTORS =================================

	/**
	 * Create an data source type type.
	 *
	 * @param label
	 *            display name
	 */
	private DataSourceType(final String label)
	{
		this.label = label;
	}

	// ========================= IMPL: Labeled ================================

	/**
	 * Return the label property.
	 *
	 * @return the label
	 */
	@Override
	public String getLabel()
	{
		return label;
	}

}
