Add some comparisons methods, fix the existing checks
[jvcard.git] / src / be / nikiroo / jvcard / Card.java
index e82ce7cc933ebb864a2b7b405875d09865d12cf9..986f81d17c0932cba2081d7586b0ce115ad25547 100644 (file)
@@ -3,11 +3,11 @@ package be.nikiroo.jvcard;
 import java.io.BufferedReader;
 import java.io.BufferedWriter;
 import java.io.File;
-import java.io.FileReader;
+import java.io.FileInputStream;
 import java.io.FileWriter;
 import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Arrays;
+import java.io.InputStreamReader;
+import java.security.InvalidParameterException;
 import java.util.LinkedList;
 import java.util.List;
 
@@ -21,133 +21,244 @@ import be.nikiroo.jvcard.parsers.Parser;
  * @author niki
  * 
  */
-public class Card {
-       private List<Contact> contacts;
+public class Card extends BaseClass<Contact> {
        private File file;
-       private boolean dirty;
        private String name;
        private Format format;
+       private long lastModified;
+       private boolean remote;
 
+       /**
+        * Create a new {@link Card} from the given {@link File} and {@link Format}.
+        * 
+        * @param file
+        *            the input {@link File} containing the {@link Card} data or
+        *            NULL for an empty card (usually a {@link File} name or a
+        *            network path)
+        * @param format
+        *            the {@link Format} to use to parse it
+        * 
+        * @throws IOException
+        *             in case of IO error
+        * @throws InvalidParameterException
+        *             if format is NULL
+        */
        public Card(File file, Format format) throws IOException {
-               this.file = file;
-               this.format = format;
+               this(load(file, format));
 
                if (file != null) {
-                       name = file.getName();
+                       if (file.exists()) {
+                               lastModified = file.lastModified();
+                       }
                }
 
-               BufferedReader buffer = new BufferedReader(new FileReader(file));
-               List<String> lines = new LinkedList<String>();
-               for (String line = buffer.readLine(); line != null; line = buffer
-                               .readLine()) {
-                       lines.add(line);
-               }
-               buffer.close();
+               this.format = format;
 
-               load(lines, format);
-               dirty = false; // initial load, so no change yet, so no need to call
-                                               // setPristine()
+               if (file != null) {
+                       this.file = file;
+                       switch (format) {
+                       case VCard21:
+                               this.name = file.getName().replaceAll(".[vV][cC][fF]$", "");
+                               break;
+                       case Abook:
+                       default:
+                               this.name = file.getName();
+                               break;
+                       }
+               }
        }
 
        /**
-        * Return the full list of {@link Contact}s. Please use responsibly (this is
-        * the original list, do not modify the list itself).
+        * Create a new {@link Card} from the given {@link Contact}s.
+        * 
+        * @param contacts
+        *            the input contacts
         * 
-        * @return the list of {@link Contact}s
+        * @throws IOException
+        *             in case of IO error
+        * @throws InvalidParameterException
+        *             if format is NULL
         */
-       public List<Contact> getContactsList() {
-               return contacts;
+       public Card(List<Contact> contacts) throws IOException {
+               super(contacts);
+
+               lastModified = -1;
        }
 
        /**
-        * Return the list of {@link Contact}s. Note that this list is a copy.
+        * Save the {@link Card} to the given {@link File} with the given
+        * {@link Format}.
+        * 
+        * @param output
+        *            the output to save to
+        * @param format
+        *            the {@link Format} to use
+        * 
+        * @return TRUE if it was saved
         * 
-        * @return the list of {@link Contact}s
+        * @throws IOException
+        *             in case of IO errors
         */
-       public List<Contact> getContacts() {
-               ArrayList<Contact> list = new ArrayList<Contact>(size());
-               list.addAll(contacts);
-               return list;
-       }
-
-       public int size() {
-               return contacts.size();
-       }
-
-       public Contact get(int index) {
-               return contacts.get(index);
-       }
-
-       public boolean saveAs(File file, Format format) throws IOException {
-               if (file == null)
+       public boolean saveAs(File output, Format format) throws IOException {
+               if (output == null)
                        return false;
 
-               BufferedWriter writer = new BufferedWriter(new FileWriter(file));
+               BufferedWriter writer = new BufferedWriter(new FileWriter(output));
                writer.append(toString(format));
                writer.close();
 
-               if (file.equals(this.file)) {
+               if (output.getCanonicalPath().equals(this.file.getCanonicalPath())) {
                        setPristine();
                }
 
                return true;
        }
 
+       /**
+        * Save the {@link Card} to the original {@link File} it was open from.
+        * 
+        * @return TRUE if it was saved
+        * 
+        * @throws IOException
+        *             in case of IO errors
+        */
        public boolean save() throws IOException {
                return saveAs(file, format);
        }
 
+       /**
+        * Reload the data from the input.
+        * 
+        * @return TRUE if it was done
+        * 
+        * @throws IOException
+        *             in case of IO error
+        */
+       public boolean reload() throws IOException {
+               if (file == null)
+                       return false;
+
+               this.replaceListContent(load(file, format));
+               setPristine();
+               return true;
+       }
+
+       /**
+        * Return a {@link String} representation of this {@link Card} in the given
+        * {@link Format}.
+        * 
+        * @param format
+        *            the {@link Format} to use
+        * 
+        * @return the {@link String}
+        */
        public String toString(Format format) {
                return Parser.toString(this, format);
        }
 
-       public String toString() {
-               return toString(Format.VCard21);
+       /**
+        * Return the name of this card (the name of the {@link File} which it was
+        * opened from).
+        * 
+        * @return the name
+        */
+       public String getName() {
+               return name;
        }
 
-       protected void load(String serializedContent, Format format) {
-               // note: fixed size array
-               List<String> lines = Arrays.asList(serializedContent.split("\n"));
-               load(lines, format);
+       /**
+        * Return the original {@link Format} of the {@link Card}.
+        * 
+        * @return the {@link Format}
+        */
+       public Format getFormat() {
+               return format;
        }
 
-       protected void load(List<String> lines, Format format) {
-               this.contacts = Parser.parse(lines, format);
-               setDirty();
-
-               for (Contact contact : contacts) {
-                       contact.setParent(this);
-               }
+       /**
+        * Return the {@link File} which was used to open this {@link Card}.
+        * 
+        * @return the input
+        */
+       public File getFile() {
+               return file;
        }
 
-       public boolean isDirty() {
-               return dirty;
+       /**
+        * Return the date of the last modification for this {@link Card} (or -1 if
+        * unknown/new).
+        * 
+        * @return the last modified date
+        */
+       public long getLastModified() {
+               return lastModified;
        }
 
        /**
-        * Return the name of this card.
+        * Check if this {@link Card} is remote.
         * 
-        * @return the name
+        * @return TRUE if this {@link Card} is remote
         */
-       public String getName() {
-               return name;
+       public boolean isRemote() {
+               return remote;
        }
 
        /**
-        * Notify that this element has unsaved changes.
+        * Set the remote option on this {@link Card}.
+        * 
+        * @param remote
+        *            TRUE if this {@link Card} is remote
         */
-       void setDirty() {
-               dirty = true;
+       public void setRemote(boolean remote) {
+               this.remote = remote;
+       }
+
+       @Override
+       public String toString() {
+               return toString(Format.VCard21);
+       }
+
+       @Override
+       public String getId() {
+               return "" + name;
+       }
+
+       @Override
+       public String getState() {
+               return "" + name + format;
        }
 
        /**
-        * Notify this element <i>and all its descendants</i> that it is in pristine
-        * state (as opposed to dirty).
+        * Load the data from the given {@link File} under the given {@link Format}.
+        * 
+        * @param file
+        *            the input to load from
+        * @param format
+        *            the {@link Format} to load as
+        * 
+        * @return the list of elements
+        * 
+        * @throws IOException
+        *             in case of IO error
         */
-       void setPristine() {
-               dirty = false;
-               for (Contact contact : contacts) {
-                       contact.setPristine();
+       private static List<Contact> load(File file, Format format)
+                       throws IOException {
+               List<String> lines = null;
+
+               if (file != null && file.exists()) {
+                       BufferedReader buffer = new BufferedReader(new InputStreamReader(
+                                       new FileInputStream(file), "UTF-8"));
+                       lines = new LinkedList<String>();
+                       for (String line = buffer.readLine(); line != null; line = buffer
+                                       .readLine()) {
+                               lines.add(line);
+                       }
+                       buffer.close();
                }
+
+               if (lines == null)
+                       return new LinkedList<Contact>();
+
+               return Parser.parse(lines, format);
        }
 }