/* ======================================================================
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.xml;


import java.text.*;

/**
 *
 * @author  jrm
 */
public class Word implements Cloneable
{
    // The word as a string in original form.
    String source;

    // The id of the first word in the database that is equal according
    // to various strength settings of the collator.
    // The identical_id refers to the ID of the entry for this word
    // and any of the other may be equal to that or a lower id value
    // because they match a word that was put in the database before
    // this word was deposited.
    
    // The order of the array is primary, secondary, tertiary, identical
    
    int id[] = new int[4];

    // The collation keys - these are not stored in the database, they are
    // regenerated when the word is loaded from the database or when a new
    // word is deposited.  The system administrator will need to rebuild the
    // word records if the collation scheme is changed because these need
    // to work with the stored id values.

    // The order of the array is primary, secondary, tertiary,
    CollationKey[] key = new CollationKey[3];

    private Word()
    {
    }
    
    /** Creates a new instance of Word */
    public Word( String s, int id1, int id2, int id3, int idi, CollationKey k1, CollationKey k2, CollationKey k3 )
    {
        source = s;
        
        id[0] = id1;
        id[1] = id2;
        id[2] = id3;
        id[3] = idi;
        
        key[0] =  k1;
        key[1] =  k2;
        key[2] =  k3;
    }
    
    public String getSource()
    {
        return source;
    }
    
    public void setSource( String s )
    {
        source =s;
    }
    
    public CollationKey getCollationKey( int strength )
    {
        switch ( strength )
        {
            case Collator.PRIMARY:
                return key[0];
            case Collator.SECONDARY:
                return key[1];
            case Collator.TERTIARY:
                return key[2];
        }
        throw new IllegalArgumentException( "Unknown collation strength." );
    }

    public void setCollationKey( CollationKey k, int strength )
    {
        switch ( strength )
        {
            case Collator.PRIMARY:
                key[0]=k;
                return;
            case Collator.SECONDARY:
                key[1]=k;
                return;
            case Collator.TERTIARY:
                key[2]=k;
                return;
        }
        throw new IllegalArgumentException( "Unknown collation strength." );
    }
    
    public int getID( int strength )
    {
        switch ( strength )
        {
            case Collator.PRIMARY:
                return id[0];
            case Collator.SECONDARY:
                return id[1];
            case Collator.TERTIARY:
                return id[2];
            case Collator.IDENTICAL:
                return id[3];
        }
        throw new IllegalArgumentException( "Unknown collation strength." );
    }

    public void setID( int i, int strength )
    {
        switch ( strength )
        {
            case Collator.PRIMARY:
                id[0] = i;
                return;
            case Collator.SECONDARY:
                id[1] = i;
                return;
            case Collator.TERTIARY:
                id[2] = i;
                return;
            case Collator.IDENTICAL:
                id[3] = i;
                return;
        }
        throw new IllegalArgumentException( "Unknown collation strength." );
    }

    public Object clone()
    throws CloneNotSupportedException
    {
        Word w = new Word();
        System.arraycopy( this.id, 0, w.id, 0, 4 );
        System.arraycopy( this.key, 0, w.key, 0, 3 );
        w.source = this.source;
        return w;
    }
    
    public int hashCode()
    {
        return source.hashCode();
    }
    
    public boolean equals( Object other )
    {
        if ( !(other instanceof Word) )
            return false;
        Word other_word = (Word)other;
        return this.source.equals( other_word.getSource() );
    }
}