RTMLImageData.java

/*   
    Copyright 2006, Astrophysics Research Institute, Liverpool John Moores University.

    This file is part of org.estar.rtml.

    org.estar.rtml 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 2 of the License, or
    (at your option) any later version.

    org.estar.rtml 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 org.estar.rtml; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
// RTMLImageData.java
// $Header: /space/home/eng/cjm/cvs/org_estar_rtml/RTMLImageData.java,v 1.5 2008-05-27 14:15:55 cjm Exp $
package org.estar.rtml;

import java.io.*;
import java.net.*;

/**
 * This class is a data container for information contained in the ImageData nodes/tags of an RTML document.
 * @author Chris Mottram
 * @version $Revision$
 */
public class RTMLImageData implements Serializable
{
	/**
	 * Revision control system version id.
	 */
	public final static String RCSID = "$Id$";
	/**
	 * Serial version ID. Fixed as these documents can be used as parameters in RMI calls across JVMs.
	 */
	static final long serialVersionUID = -6324753364425492455L;
	/**
	 * The type of the object list belonging to this observation. Either "xml", "cluster" or "votable-url".
	 */
	private String objectListType = null;
	/**
	 * A string, containing the contents of a cluster format object list file.
	 */
	private String objectListClusterString = null;
	/**
	 * The URL containing the location of a VOTable containing information about objects in the image.
	 */
	private URL objectListVOTableURL = null;
	/**
	 * The ImageData type string containing the format of the image data.
	 * Should be a valid %imageFormats; ENTITY, see DTD (FITS|FITS16|gif|jpg|JPEG).
	 */
	private String imageDataType = null;
	/**
	 * The URL containing the location of the image data.
	 */
	private URL imageDataURL = null;
	/**
	 * A string, containing the FITS header from the image data/observation.
	 */
	private String fitsHeader = null;

	/**
	 * Default constructor.
	 */
	public RTMLImageData()
	{
		super();
	}

	/**
	 * Set the object list type.
	 * @param s The type of the object list. Should be either "cluster", "xml" or "votable-url". 
	 *          See DTD, %objectListTypes;.
	 * @exception IllegalArgumentException Thrown if the type is nor legal.
	 * @see #objectListType
	 */
	public void setObjectListType(String s)
	{
		if((s.equals("xml") == false)&&(s.equals("cluster") == false)&&(s.equals("votable-url") == false))
		{
			throw new IllegalArgumentException(this.getClass().getName()+
							   ":setObjectListType:Object List Type "+
							   s+" not legal.");
		}
		objectListType = s;
	}

	/**
	 * Return the object list.
	 */
	public String getObjectListType()
	{
		return objectListType;
	}

	/**
	 * Return whether the object list type is "cluster".
	 * @return True if the object list type is cluster, false if it is not, or has not been set yet.
	 */
	public boolean isObjectListTypeCluster()
	{
		if(objectListType == null)
			return false;
		return objectListType.equals("cluster");
	}

	public void setObjectListCluster(String s)
	{
		objectListClusterString = s;
	}

	public String getObjectListCluster()
	{
		return objectListClusterString;
	}

	/**
	 * Return whether the object list type is "votable-url".
	 * @return True if the object list type is votable-url, false if it is not, or has not been set yet.
	 */
	public boolean isObjectListTypeVOTableURL()
	{
		if(objectListType == null)
			return false;
		return objectListType.equals("votable-url");
	}

	/**
	 * Set the VOTable URL.
	 * @param u The URL.
	 * @see #objectListVOTableURL
	 */
	public void setObjectListVOTableURL(URL u)
	{
		objectListVOTableURL = u;
	}

	/**
	 * Routine to set the VOTable URL.
	 * @param s The string to create a URL from.
	 * @exception RTMLException Thrown if the string is not a valid URL.
	 */
	public void setObjectListVOTableURL(String s) throws RTMLException
	{
		try
		{
			objectListVOTableURL = new URL(s);
		}
		catch(MalformedURLException e)
		{
			throw new RTMLException(this.getClass().getName()+"setObjectListVOTableURL:Malformed URL:"+s,e);
		}
	}

	/**
	 * Get the VOTable URL.
	 * @return The URL.
	 * @see #objectListVOTableURL
	 */
	public URL getObjectListVOTableURL()
	{
		return objectListVOTableURL;
	}

	/**
	 * Routine to set the image data Type.
	 * @param s The string containing a valid type. See %imageFormats; ENTITY in DTD.
	 * @exception RTMLException Thrown if the image data type string is not a valid type.
	 * @see #imageDataType
	 */
	public void setImageDataType(String s) throws RTMLException
	{
		if(!(s.equals("FITS")||s.equals("FITS16")||s.equals("gif")||s.equals("jpg")||s.equals("JPEG")))
			throw new RTMLException(this.getClass().getName()+":setImageDataType:Illegal Type:"+s);
		imageDataType = s;
	}

	/**
	 * Get the image data type.
	 * @see #imageDataType
	 */
	public String getImageDataType()
	{
		return imageDataType;
	}

	/**
	 * Routine to set the image data URL.
	 * @param s The string to create a URL from.
	 * @exception RTMLException Thrown if the image data string is not a valid URL.
	 */
	public void setImageDataURL(String s) throws RTMLException
	{
		try
		{
			imageDataURL = new URL(s);
		}
		catch(MalformedURLException e)
		{
			throw new RTMLException(this.getClass().getName()+"setImageDataURL:Malformed URL:"+s,e);
		}
	}

	public URL getImageDataURL()
	{
		return imageDataURL;
	}

	public void setFITSHeader(String s)
	{
		fitsHeader = s;
	}

	public String getFITSHeader()
	{
		return fitsHeader;
	}

	/**
	 * Method to print out a string representation of this node.
	 */
	public String toString()
	{
		return toString("");
	}

	/**
	 * Method to print out a string representation of this node, with a prefix.
	 * @param prefix A string to prefix to each line of data we print out.
	 * @see #objectListClusterString
	 * @see #objectListVOTableURL
	 * @see #objectListType
	 * @see #imageDataType
	 * @see #imageDataURL
	 * @see #fitsHeader
	 */
	public String toString(String prefix)
	{
		StringBuffer sb = null;
		
		sb = new StringBuffer();
		sb.append(prefix+"ImageData\n");
		if(isObjectListTypeCluster()&&(objectListClusterString != null))
		{
			sb.append(prefix+"\tObjectList: type = cluster\n");
			sb.append(prefix+"\t"+objectListClusterString+"\n");
		}
		if(isObjectListTypeVOTableURL()&&(objectListVOTableURL != null))
		{
			sb.append(prefix+"\tObjectList: type = votable-url\n");
			sb.append(prefix+"\t"+objectListVOTableURL+"\n");
		}
		if(imageDataType != null)
			sb.append(prefix+"\tImageDataType: "+imageDataType+"\n");
		if(imageDataURL != null)
			sb.append(prefix+"\tImageData: "+imageDataURL+"\n");
		if(fitsHeader != null)
			sb.append(prefix+"\tFITSHeader: "+fitsHeader+"\n");
		return sb.toString();
	}
}
/*
** $Log: not supported by cvs2svn $
** Revision 1.4  2008/05/23 14:25:33  cjm
** Comment changes.
**
** Revision 1.3  2007/01/30 18:31:16  cjm
** gnuify: Added GNU General Public License.
**
** Revision 1.2  2005/08/19 17:00:44  cjm
** Added VOTable URL support.
**
** Revision 1.1  2005/05/04 18:54:26  cjm
** Initial revision
**
*/