/**

  *  @author : Paul Taylor

  *  @author : Eric Farng

  *

  *  Version @version:$Id: FieldFrameBodyIMG.java,v 1.11 2008/07/21 10:45:49 paultaylor Exp $

  *

  *  MusicTag Copyright (C)2003,2004

  *

  *  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,

  *  you can get a copy from http://www.opensource.org/licenses/lgpl-license.php or write to the Free Software

  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

  *

  * Description:

  */

 package org.jaudiotagger.tag.lyrics3;

 import org.jaudiotagger.tag.InvalidTagException;

 import org.jaudiotagger.tag.TagOptionSingleton;

 import org.jaudiotagger.tag.datatype.Lyrics3Image;

 import java.io.RandomAccessFile;

 import java.nio.ByteBuffer;

 import java.util.ArrayList;

 import java.util.Iterator;

 public class FieldFrameBodyIMG extends AbstractLyrics3v2FieldFrameBody

 {

     /**

      *

      */

     private ArrayList<Lyrics3Image> images = new ArrayList<Lyrics3Image>();

     /**

      * Creates a new FieldBodyIMG datatype.

      */

     public FieldFrameBodyIMG()

     {

     }

     public FieldFrameBodyIMG(FieldFrameBodyIMG copyObject)

     {

         super(copyObject);

         Lyrics3Image old;

         for (int i = 0; i < copyObject.images.size(); i++)

         {

             old = copyObject.images.get(i);

             this.images.add(new Lyrics3Image(old));

         }

     }

     /**

      * Creates a new FieldBodyIMG datatype.

      *

      * @param imageString

      */

     public FieldFrameBodyIMG(String imageString)

     {

         readString(imageString);

     }

     /**

      * Creates a new FieldBodyIMG datatype.

      *

      * @param image

      */

     public FieldFrameBodyIMG(Lyrics3Image image)

     {

         images.add(image);

     }

     /**

      * Creates a new FieldBodyIMG datatype.

      *

      * @throws InvalidTagException

      */

     public FieldFrameBodyIMG(ByteBuffer byteBuffer) throws InvalidTagException

     {

         this.read(byteBuffer);

     }

     /**

      * @return

      */

     public String getIdentifier()

     {

         return "IMG";

     }

     /**

      * @return

      */

     public int getSize()

     {

         int size = 0;

         Lyrics3Image image;

         for (Object image1 : images)

         {

             image = (Lyrics3Image) image1;

             size += (image.getSize() + 2); // add CRLF pair

         }

         return size - 2; // cut off trailing crlf pair

     }

     /**

      * @param obj

      * @return

      */

     public boolean isSubsetOf(Object obj)

     {

         if ((obj instanceof FieldFrameBodyIMG) == false)

         {

             return false;

         }

         ArrayList<Lyrics3Image> superset = ((FieldFrameBodyIMG) obj).images;

         for (Object image : images)

         {

             if (superset.contains(image) == false)

             {

                 return false;

             }

         }

         return super.isSubsetOf(obj);

     }

     /**

      * @param value

      */

     public void setValue(String value)

     {

         readString(value);

     }

     /**

      * @return

      */

     public String getValue()

     {

         return writeString();

     }

     /**

      * @param image

      */

     public void addImage(Lyrics3Image image)

     {

         images.add(image);

     }

     /**

      * @param obj

      * @return

      */

     public boolean equals(Object obj)

     {

         if ((obj instanceof FieldFrameBodyIMG) == false)

         {

             return false;

         }

         FieldFrameBodyIMG object = (FieldFrameBodyIMG) obj;

         if (this.images.equals(object.images) == false)

         {

             return false;

         }

         return super.equals(obj);

     }

     /**

      * @return

      */

     public Iterator<Lyrics3Image> iterator()

     {

         return images.iterator();

     }

     public void read(ByteBuffer byteBuffer) throws InvalidTagException

     {

         String imageString;

         byte[] buffer = new byte[5];

         // read the 5 character size

         byteBuffer.get(buffer, 0, 5);

         int size = Integer.parseInt(new String(buffer, 0, 5));

         if ((size == 0) && (TagOptionSingleton.getInstance().isLyrics3KeepEmptyFieldIfRead() == false))

         {

             throw new InvalidTagException("Lyircs3v2 Field has size of zero.");

         }

         buffer = new byte[size];

         // read the SIZE length description

         byteBuffer.get(buffer);

         imageString = new String(buffer);

         readString(imageString);

     }

     /**

      * @return

      */

     public String toString()

     {

         String str = getIdentifier() + " : ";

         for (Object image : images)

         {

             str += (image.toString() + " ; ");

         }

         return str;

     }

     /**

      * @param file

      * @throws java.io.IOException

      */

     public void write(RandomAccessFile file) throws java.io.IOException

     {

         int size = 0;

         int offset = 0;

         byte[] buffer = new byte[5];

         String str;

         size = getSize();

         str = Integer.toString(size);

         for (int i = 0; i < (5 - str.length()); i++)

         {

             buffer[i] = (byte) '0';

         }

         offset += (5 - str.length());

         for (int i = 0; i < str.length(); i++)

         {

             buffer[i + offset] = (byte) str.charAt(i);

         }

         offset += str.length();

         file.write(buffer, 0, 5);

         if (size > 0)

         {

             str = writeString();

             buffer = new byte[str.length()];

             for (int i = 0; i < str.length(); i++)

             {

                 buffer[i] = (byte) str.charAt(i);

             }

             file.write(buffer);

         }

     }

     /**

      * @param imageString

      */

     private void readString(String imageString)

     {

         // now read each picture and put in the vector;

         Lyrics3Image image;

         String token = "";

         int offset = 0;

         int delim = imageString.indexOf(Lyrics3v2Fields.CRLF);

         images = new ArrayList<Lyrics3Image>();

         while (delim >= 0)

         {

             token = imageString.substring(offset, delim);

             image = new Lyrics3Image("Image", this);

             image.setFilename(token);

             images.add(image);

             offset = delim + Lyrics3v2Fields.CRLF.length();

             delim = imageString.indexOf(Lyrics3v2Fields.CRLF, offset);

         }

         if (offset < imageString.length())

         {

             token = imageString.substring(offset);

             image = new Lyrics3Image("Image", this);

             image.setFilename(token);

             images.add(image);

         }

     }

     /**

      * @return

      */

     private String writeString()

     {

         String str = "";

         Lyrics3Image image;

         for (Object image1 : images)

         {

             image = (Lyrics3Image) image1;

             str += (image.writeString() + Lyrics3v2Fields.CRLF);

         }

         if (str.length() > 2)

         {

             return str.substring(0, str.length() - 2);

         }

         return str;

     }

     /**

      * TODO

      */

     protected void setupObjectList()

     {

     }

 }