/*
 * This file is a part of EpnTAPClient.
 * This program aims to provide EPN-TAP support for software clients, like CASSIS spectrum analyzer.
 * See draft specifications: https://voparis-confluence.obspm.fr/pages/viewpage.action?pageId=559861
 * Copyright (C) 2016 Institut de Recherche en Astrophysique et Planétologie.
 *
 * This program is free software: you can
 * redistribute it and/or modify it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or (at your option) any later
 * version. This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU General Public License for more details. You should have received a copy of
 * the GNU General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 */

package eu.omp.irap.vespa.epntapclient.votable.controller;

import java.io.IOException;

/**
 * VOTableException is the global exception for all the VOTable application. All other exceptions
 * should extend it.
 *
 * @author N. Jourdane
 */
public abstract class VOTableException extends Exception {

	/** The serial version UID. */
	private static final long serialVersionUID = 1L;


	/**
	 * @param message The message describing the exception displayed in the error dialog.
	 */
	public VOTableException(String message) {
		super(message);
	}

	/**
	 * @param message The message describing the exception displayed in the error dialog.
	 * @param e The exception thrown.
	 */
	public VOTableException(String message, Exception e) {
		super(message, e);
	}


	/** Abstract exception for when the application can not send the query. */
	public abstract static class CantSendQueryException extends VOTableException {

		/**  */
		private static final long serialVersionUID = 1L;


		/**
		 * @param message The message describing the exception displayed in the error dialog.
		 */
		public CantSendQueryException(String message) {
			super(message);
		}

		/**
		 * @param message The message describing the exception displayed in the error dialog.
		 * @param e The exception thrown.
		 */
		public CantSendQueryException(String message, Exception e) {
			super(message, e);
		}


		/** The URL is not correctly formated. */
		public static class MalformedURLException extends CantSendQueryException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param url The url sent to the server.
			 * @param e The exception thrown.
			 */
			public MalformedURLException(String url, Exception e) {
				super("The URL " + url + " is not correctly formated.", e);
			}
		}

		/** The URL is not correctly formated. */
		public static class CantWriteQueryResultException extends CantSendQueryException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param url The url sent to the server.
			 * @param e The exception thrown.
			 */
			public CantWriteQueryResultException(String path, Exception e) {
				super("Can not write the query result in " + path + ".", e);
			}
		}

		/** The URL is not correctly formated. */
		public static class UnsupportedParamEncodingException extends CantSendQueryException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param url The url sent to the server.
			 * @param e The exception thrown.
			 */
			public UnsupportedParamEncodingException(String key, String value, Exception e) {
				super("The URL parameter " + key + " with value '" + value
						+ "' is not correctly encoded.", e);
			}
		}

		/** Can not print the result in the file. */
		public static class CantPrintRequestResultException extends CantSendQueryException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param resultFilePath The path of the file where the query results should be stored.
			 * @param e The exception thrown.
			 */
			public CantPrintRequestResultException(String resultFilePath, IOException e) {
				super("Can not print the result in the file " + resultFilePath, e);
			}
		}

		/** Can not open an HTTP connection to the specified URL. */
		public static class CantOpenConnectionException extends CantSendQueryException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param url The url sent to the server.
			 * @param e The exception thrown.
			 */
			public CantOpenConnectionException(String url, IOException e) {
				super("Can not open an HTTP connection to " + url, e);
			}
		}

		/** Can not get the server response code for the request. */
		public static class CantGetResponseCode extends CantSendQueryException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param url The url sent to the server.
			 * @param e The exception thrown.
			 */
			public CantGetResponseCode(String url, IOException e) {
				super("Can not get the server response code for the request " + url, e);
			}
		}

		/** The server returned the bad response code (but not 400). */
		public static class BadResponseCodeException extends CantSendQueryException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param url The url sent to the server.
			 * @param responseCode The HTTP GET response code, which is bad.
			 */
			public BadResponseCodeException(String url, int responseCode) {
				super("The server returned the bad response code `" + responseCode
						+ "` for the request " + url);
			}
		}

		/** Can not get the input stream of the result, neither the error stream. */
		public static class CantGetErrorStream extends CantSendQueryException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param url The url sent to the server.
			 * @param e The exception thrown.
			 */
			public CantGetErrorStream(String url, IOException e) {
				super("Can not get the input stream of the result, neither the error stream "
						+ "for the request " + url, e);
			}
		}

	}

	/** Abstract exception for when the application can not display the VOTable. */
	public abstract static class CantDisplayVOTableException extends VOTableException {

		/**  */
		private static final long serialVersionUID = 1L;


		/**
		 * @param message The message describing the exception displayed in the error dialog.
		 * @param e The exception thrown.
		 */
		public CantDisplayVOTableException(String message, Exception e) {
			super(message, e);
		}

		/**
		 * @param message The message describing the exception displayed in the error dialog.
		 */
		public CantDisplayVOTableException(String message) {
			super(message);
		}


		/** Can not parse the VOTable because it doesn't match with the VOTable schema. */
		public static class VOTableIsNotValidException extends CantDisplayVOTableException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param voTablePath The path of the VOTable.
			 * @param e The exception thrown.
			 */
			public VOTableIsNotValidException(String voTablePath, Exception e) {
				super("Can not parse the VOTable because it doesn't match with the VOTable schema."
						+ "\n See the VOTable file for more details: " + voTablePath, e);
			}
		}

		/** VOTable with more than one resource are not yet supported. */
		public static class SeveralResourcesException extends CantDisplayVOTableException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param voTablePath The path of the VOTable.
			 */
			public SeveralResourcesException(String voTablePath) {
				super("VOTable with more than one resource are not yet supported. \n"
						+ "See VOTable file for more informations: " + voTablePath);
			}
		}

		/** VOTable with more than one resource are not yet supported. */
		public static class SeveralTablesException extends CantDisplayVOTableException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param voTablePath The path of the VOTable.
			 */
			public SeveralTablesException(String voTablePath) {
				super("VOTable with more than one resource are not yet supported. \n"
						+ "See VOTable file for more informations: " + voTablePath);
			}
		}

		/** Can not change schema location on the VOTable file. */
		public static class CantModifyVOTableException extends CantDisplayVOTableException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param voTablePath The path of the VOTable.
			 * @param e The exception thrown.
			 */
			public CantModifyVOTableException(String voTablePath, Exception e) {
				super("Can not change schema location on the VOTable file: " + voTablePath, e);
			}
		}

		/** There is an error in the VOTable. */
		public static class ErrorMessageInVOTableException extends CantDisplayVOTableException {

			/**  */
			private static final long serialVersionUID = 1L;


			/**
			 * @param errorInfo The information about the error, which comes from the VOTable itself
			 *            from the "INFO" node.
			 */
			public ErrorMessageInVOTableException(String errorInfo) {
				super("There is an error in the VOTable:\n" + errorInfo
						+ "\nPlease check your ADQL query.");
			}
		}
	}

}