jackcess/src/java/com/healthmarketscience/jackcess/complex/ComplexValueForeignKey.java

/*
Copyright (c) 2011 James Ahlborn

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library 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
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
USA
*/

package com.healthmarketscience.jackcess.complex;

import java.io.IOException;
import java.io.ObjectStreamException;
import java.util.Date;
import java.util.List;
import java.util.Map;

import com.healthmarketscience.jackcess.Column;

/**
 * Value which is returned for a complex column.  This value corresponds to a
 * foreign key in a secondary table which contains the actual complex data for
 * this row (which could be 0 or more complex values for a given row).  This
 * class contains various convenience methods for interacting with the actual
 * complex values.
 * <p>
 * This class will cache the associated complex values returned from one of
 * the lookup methods.  The various modification methods will clear this cache
 * automatically.  The {@link #reset} method may be called manually to clear
 * this internal cache.
 *
 * @author James Ahlborn
 */
public class ComplexValueForeignKey extends Number
{
  private static final long serialVersionUID = 20110805L;  
  
  private transient final Column _column;
  private final int _value;
  private transient List<? extends ComplexValue> _values;
  
  public ComplexValueForeignKey(Column column, int value) {
    _column = column;
    _value = value;
  }

  public int get() {
    return _value;
  }

  public Column getColumn() {
    return _column;
  }
  
  @Override
  public byte byteValue() {
    return (byte)get();
  }
  
  @Override
  public short shortValue() {
    return (short)get();
  }
  
  @Override
  public int intValue() {
    return get();
  }
  
  @Override
  public long longValue() {
    return get();
  }
  
  @Override
  public float floatValue() {
    return get();
  }
  
  @Override
  public double doubleValue() {
    return get();
  }

  public ComplexDataType getComplexType() {
    return getComplexInfo().getType();
  }
  
  protected ComplexColumnInfo<? extends ComplexValue> getComplexInfo() {
    return _column.getComplexInfo();
  }

  protected VersionHistoryColumnInfo getVersionInfo() {
    return (VersionHistoryColumnInfo)getComplexInfo();
  }
  
  protected AttachmentColumnInfo getAttachmentInfo() {
    return (AttachmentColumnInfo)getComplexInfo();
  }

  protected MultiValueColumnInfo getMultiValueInfo() {
    return (MultiValueColumnInfo)getComplexInfo();
  }
    
  protected UnsupportedColumnInfo getUnsupportedInfo() {
    return (UnsupportedColumnInfo)getComplexInfo();
  }
    
  public int countValues()
    throws IOException
  {
    return getComplexInfo().countValues(get());
  }
  
  public List<Map<String,Object>> getRawValues()
    throws IOException
  {
    return getComplexInfo().getRawValues(get());
  }  
  
  public List<? extends ComplexValue> getValues()
    throws IOException
  {
    if(_values == null) {
      _values = getComplexInfo().getValues(this);
    }
    return _values;
  }  

  @SuppressWarnings("unchecked")
  public List<Version> getVersions()
    throws IOException
  {
    if(getComplexType() != ComplexDataType.VERSION_HISTORY) {
      throw new UnsupportedOperationException();
    }
    return (List<Version>)getValues();
  }
  
  @SuppressWarnings("unchecked")
  public List<Attachment> getAttachments()
    throws IOException
  {
    if(getComplexType() != ComplexDataType.ATTACHMENT) {
      throw new UnsupportedOperationException();
    }
    return (List<Attachment>)getValues();
  }
  
  @SuppressWarnings("unchecked")
  public List<SingleValue> getMultiValues()
    throws IOException
  {
    if(getComplexType() != ComplexDataType.MULTI_VALUE) {
      throw new UnsupportedOperationException();
    }
    return (List<SingleValue>)getValues();
  }
  
  @SuppressWarnings("unchecked")
  public List<UnsupportedValue> getUnsupportedValues()
    throws IOException
  {
    if(getComplexType() != ComplexDataType.UNSUPPORTED) {
      throw new UnsupportedOperationException();
    }
    return (List<UnsupportedValue>)getValues();
  }
  
  public void reset() {
    // discard any cached values
    _values = null;
  }
  
  public Version addVersion(String value)
    throws IOException
  {
    return addVersion(value, new Date());
  }
  
  public Version addVersion(String value, Date modifiedDate)
    throws IOException
  {
    reset();
    Version v = VersionHistoryColumnInfo.newVersion(this, value, modifiedDate);
    getVersionInfo().addValue(v);
    return v;
  }

  public Attachment addAttachment(byte[] data)
    throws IOException
  {
    return addAttachment(null, null, null, data, null, null);
  }
  
  public Attachment addAttachment(
      String url, String name, String type, byte[] data,
      Date timeStamp, Integer flags)
    throws IOException
  {
    reset();
    Attachment a = AttachmentColumnInfo.newAttachment(
        this, url, name, type, data, timeStamp, flags);
    getAttachmentInfo().addValue(a);
    return a;
  }

  public Attachment addEncodedAttachment(byte[] encodedData)
    throws IOException
  {
    return addEncodedAttachment(null, null, null, encodedData, null, null);
  }
  
  public Attachment addEncodedAttachment(
      String url, String name, String type, byte[] encodedData,
      Date timeStamp, Integer flags)
    throws IOException
  {
    reset();
    Attachment a = AttachmentColumnInfo.newEncodedAttachment(
        this, url, name, type, encodedData, timeStamp, flags);
    getAttachmentInfo().addValue(a);
    return a;
  }

  public Attachment updateAttachment(Attachment attachment)
    throws IOException
  {
    reset();
    getAttachmentInfo().updateValue(attachment);
    return attachment;
  }
  
  public Attachment deleteAttachment(Attachment attachment)
    throws IOException
  {
    reset();
    getAttachmentInfo().deleteValue(attachment);
    return attachment;
  }
  
  public SingleValue addMultiValue(Object value)
    throws IOException
  {
    reset();
    SingleValue v = MultiValueColumnInfo.newSingleValue(this, value);
    getMultiValueInfo().addValue(v);
    return v;
  }
  
  public SingleValue updateMultiValue(SingleValue value)
    throws IOException
  {
    reset();
    getMultiValueInfo().updateValue(value);
    return value;
  }
  
  public SingleValue deleteMultiValue(SingleValue value)
    throws IOException
  {
    reset();
    getMultiValueInfo().deleteValue(value);
    return value;
  }
  
  public UnsupportedValue addUnsupportedValue(Map<String,?> values)
    throws IOException
  {
    reset();
    UnsupportedValue v = UnsupportedColumnInfo.newValue(this, values);
    getUnsupportedInfo().addValue(v);
    return v;
  }
  
  public UnsupportedValue updateUnsupportedValue(UnsupportedValue value)
    throws IOException
  {
    reset();
    getUnsupportedInfo().updateValue(value);
    return value;
  }
  
  public UnsupportedValue deleteUnsupportedValue(UnsupportedValue value)
    throws IOException
  {
    reset();
    getUnsupportedInfo().deleteValue(value);
    return value;
  }
  
  public void deleteAllValues()
    throws IOException
  {
    reset();
    getComplexInfo().deleteAllValues(this);
  }
  
  private Object writeReplace() throws ObjectStreamException {
    // if we are going to serialize this ComplexValueForeignKey, convert it
    // back to a normal Integer (in case it is restored outside of the context
    // of jackcess)
    return Integer.valueOf(_value);
  }
  
  @Override
  public int hashCode() {
    return _value;
  }
  
  @Override
  public boolean equals(Object o) {
    return ((this == o) ||
            ((o != null) && (getClass() == o.getClass()) &&
             (_value == ((ComplexValueForeignKey)o)._value) &&
             (_column == ((ComplexValueForeignKey)o)._column)));
  }

  @Override
  public String toString() {
    return String.valueOf(_value);
  }  
}