/* ======================================================================
The Bodington System Software License, Version 1.0
  
Copyright (c) 2001 The University of Leeds.  All rights reserved.
  
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1.  Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2.  Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3.  The end-user documentation included with the redistribution, if any,
must include the following acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.

4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.

5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES 
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO 
EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS CONTRIBUTORS BE LIABLE FOR 
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
=========================================================

This software was originally created by the University of Leeds and may contain voluntary 
contributions from others.  For more information on the Bodington Open Source Project, please 
see http://bodington.org/

====================================================================== */

package org.bodington.server.resources;

import org.bodington.database.*;
import org.bodington.sqldatabase.*;

public class UploadedFileIndexKey
    implements IndexKey
    {
    PrimaryKey resource_id;
    PrimaryKey parent_uploaded_file_id;
    String name;

    UploadedFileIndexKey()
        {
	resource_id = null;
	parent_uploaded_file_id = null;
	name = null;
        }
        
    public boolean cacheNull()
        {
        return false;
        }
        
    public String whereClause()
        {
        StringBuffer where = new StringBuffer();
        
        where.append( "resource_id " );
        if ( resource_id == null )
            where.append( "IS NULL" );
        else
	    {
	    where.append( "= " );
            where.append( resource_id.toString() );
	    }
	
        if ( parent_uploaded_file_id == null )
        {
            // it is logical that when parent_uploaded_file_id is null
            // that left_index = 0 and vice versa so this is valid
            // alternative, and in MS SQL the query runs much much
            // faster because it uses a better scheme for loading
            // records from the objects table.
            where.append( " AND left_index = 0 " );
        }
        else
	    {
            where.append( " AND parent_uploaded_file_id " );
	    where.append( "= " );
            where.append( parent_uploaded_file_id.toString() );

	    where.append( " AND name " );
	    if ( name == null )
		where.append( "IS NULL" );
	    else
		{
		where.append( "= " );
		where.append( SqlDatabase.quotedSQL( name ) );
		}
	    }
        return where.toString();
        }
    
    void setResourceId( PrimaryKey id )
        {
        resource_id = id;
        }
    PrimaryKey getResourceId()
        {
        return resource_id;
        }
    
    void setParentUploadedFileId( PrimaryKey id )
        {
        parent_uploaded_file_id = id;
        }
    PrimaryKey getParentUploadedFileId()
        {
        return parent_uploaded_file_id;
        }
    
    void setName( String u )
        {
        name = u;
        }
    String getName()
        {
        return name;
        }
    
    public boolean equals(Object obj)
        {
        if ( !(obj instanceof UploadedFileIndexKey) )
            return false;

        UploadedFileIndexKey other = (UploadedFileIndexKey)obj;
        
        if ( other.name==null || this.name==null )
            return false;
        
	
	if (	!((other.resource_id == null && 
		   this.resource_id == null)      ||
		  (other.resource_id !=null && 
		   this.resource_id != null &&
		   other.resource_id.equals( this.resource_id ) ) ) )
	    return false;

	// for root folders ignore names
	if (	other.parent_uploaded_file_id == null && 
		  this.parent_uploaded_file_id == null   )
	    return true;

	// not equal if one is root and one isn't
	if (	other.parent_uploaded_file_id == null ||
		  this.parent_uploaded_file_id == null  )
	    return false;
	
	// not equal if not siblings
	if ( !other.parent_uploaded_file_id.equals( this.parent_uploaded_file_id ) )
	    return false;
	
	// equal if neither have names
	if ( (this.name == null || this.name.length()==0) && 
		(other.name == null || other.name.length()==0) )
	    return true;
	
	// not equal if one has a name and the other hasn't
	if ( (this.name == null || this.name.length()==0) || 
		(other.name == null || other.name.length()==0) )
	    return false;

	// equal if both have the same name
	// This is case sensitive which means that two apparently different
	// keys may map to the same database record depending on the case
	// insensitivity of the database.  Problem is that the equalsIgnoreCase
	// may ignore case for more alphabets than the database comparison.
	// It's better to have two keys onto one record than have a key
	// return a record in cache that wouldn't have been found by a 
	// database query.
	return other.name.equals( this.name );
        }

    public int hashCode()
        {
	if ( parent_uploaded_file_id != null )
	    return parent_uploaded_file_id.intValue();
	if ( resource_id != null )
	    return resource_id.intValue();
        if ( name==null )
	    return 0;
        return name.hashCode();
        }

    }