PT_Envelope.java

/*
 * OpenGIS� Coordinate Transformation Services Implementation Specification
 * Copyright (2001) OpenGIS consortium
 *
 * THIS COPYRIGHT NOTICE IS A TEMPORARY PATCH.   Version 1.00 of official
 * OpenGIS's interface files doesn't contain a copyright notice yet. This
 * file is a slightly modified version of official OpenGIS's interface.
 * Changes have been done in order to fix RMI problems and are documented
 * on the SEAGIS web site (seagis.sourceforge.net). THIS FILE WILL LIKELY
 * BE REPLACED BY NEXT VERSION OF OPENGIS SPECIFICATIONS.
 */
package org.opengis.pt;

// Various JDK's classes
import java.io.Serializable;


/**
 * A box defined by two positions.
 * The two positions must have the same dimension.
 * Each of the ordinate values in the minimum point must be less than or equal
 * to the corresponding ordinate value in the maximum point.  Please note that
 * these two points may be outside the valid domain of their coordinate system.
 * (Of course the points and envelope do not explicitly reference a coordinate
 * system, but their implicit coordinate system is defined by their context.)
 *
 * @version 1.01
 * @since   1.00
 * @author Martin Daly
 * @author Martin Desruisseaux
 */
public class PT_Envelope implements Cloneable, Serializable
{
    /**
     * Use <code>serialVersionUID</code> from first
     * draft for interoperability with CSS 1.00.
     */
    private static final long serialVersionUID = -1819256261961411213L;

    /**
     * Point containing minimum ordinate values.
     */
    public PT_CoordinatePoint minCP;

    /**
     * Point containing maximum ordinate values.
     */
    public PT_CoordinatePoint maxCP;

    /**
     * Construct an empty envelope. Caller must
     * initialize {@link #minCP} and {@link #maxCP}.
     */
    public PT_Envelope()
    {}

    /**
     * Returns a hash value for this envelope.
     * This value need not remain consistent between
     * different implementations of the same class.
     */
    public int hashCode()
    {
        int code = 7896312;
        if (minCP!=null) code = code*37 + minCP.hashCode();
        if (maxCP!=null) code = code*37 + maxCP.hashCode();
        return code;
    }

    /**
     * Compares the specified object with
     * this envelope for equality.
     */
    public boolean equals(final Object object)
    {
        if (object!=null && getClass().equals(object.getClass()))
        {
            final PT_Envelope that = (PT_Envelope) object;
            return (minCP==that.minCP || (minCP!=null && minCP.equals(that.minCP))) &&
                   (maxCP==that.maxCP || (maxCP!=null && maxCP.equals(that.maxCP)));
        }
        return false;
    }

    /**
     * Returns a deep copy of this envelope.
     */
    public Object clone()
    {
        try
        {
            final PT_Envelope copy = (PT_Envelope) super.clone();
            if (copy.minCP!=null) copy.minCP = (PT_CoordinatePoint) copy.minCP.clone();
            if (copy.maxCP!=null) copy.maxCP = (PT_CoordinatePoint) copy.maxCP.clone();
            return copy;
        }
        catch (CloneNotSupportedException exception)
        {
            // Should not happen, since we are cloneable.
            throw new InternalError(exception.getMessage());
        }
    }

    /**
     * Returns a string representation of this envelope.
     * The returned string is implementation dependent.
     * It is usually provided for debugging purposes only.
     */
    public String toString()
    {
        final StringBuffer buffer=new StringBuffer("PT_Envelope");
        buffer.append('[');
        buffer.append(minCP);
        buffer.append(", ");
        buffer.append(maxCP);
        buffer.append(']');
        return buffer.toString();
    }
}
/* ********************************************************************
Changes to this class. What the people have been up to:
$Log: PT_Envelope.java,v $
Revision 1.2  2006/07/13 06:28:31  poth
comment footer added

********************************************************************** */