/******************************************************************************

  * Filter.java - Define the filters for one pic.

  * 

  * PicMan - The BuckoSoft Picture Manager in Java

  * Copyright(c) 2005 - Dick Balaska

  * 

  */

 package com.buckosoft.PicMan.domain;

 import java.io.Serializable;

 import java.util.Date;

 import java.util.LinkedHashMap;

 /** Describe the contents of one Pic. <br>

  * The Binding is accomplished with Pic Names and not pids so that Filters can be applicable on different machines.

  * Depending on which machine imported the Pic and when they were synchronized, the pids might not line up

  * whereas Pic Name is unique. <br>

  * The filters are stored in a HashMap.  Typically the set/size is indexed by setName_size. i.e. "CarlB_75" which

  * specifies the CarlB set for size 75.

  * @author Dick Balaska

  * @since 2005/07/30

  */

 public class Filter implements Serializable {

         private static final long serialVersionUID = 1L;

         private        String                        picName;

         private        Date                date = new Date();

         private        LinkedHashMap<String, Integer>        filters = new LinkedHashMap<String, Integer>();

         /** Construct an empty Filter

          */

         public Filter() {

         }

         /** Construct a Filter setting the name of the {@link com.buckosoft.PicMan.domain.Pic} that this Filter belongs to

          * @param name the Pic Name

          */

         public Filter(String name) {

                 picName = name;

         }

         /** Set the name of the {@link com.buckosoft.PicMan.domain.Pic} that this Filter belongs to

          * @param picName the Pic Name

          */

         public void setPicName(String picName) {

                 this.picName = picName;

         }

         /** Return the name of the Pic.  This is the key that matches a Pic with a Filter.

          * @return The PicName of this Filter.

          */

         public String getPicName() {

                 return picName;

         }

 //        public void setFilters(LinkedHashMap<String, Integer> filters) {

 //                this.filters = filters;

 //        }

         /** Get a reference to the filter hashmap

          * @return the filters

          */

         public LinkedHashMap<String, Integer> getFilters() {

                 return filters;

         }

         /** Get the filter value for this string value.

          * Typically this is a constructed set_size name.

          * @param f The name of the {@link com.buckosoft.PicMan.domain.Set} to query

          * @return The value 0-9 for the filter of this set

          */ 

         public int        getFilter(String f) {

                 Integer i = (Integer)filters.get(f);

                 if (i == null)

                         return(0);

                 return(i.intValue());

         }

         /** Get the filter value for this set/size.

          * @param setName The name of the Set to query

          * @param size The size to query

          * @return The value 0-9 for the filter of this set/size.

          */

         public        int                getFilter(String setName, int size) {

                 String        s = setName + "_" + size;

                 return(getFilter(s));

         }

         /** Add this value to the Filter for this set

          * @param setName The name of the Set

          * @param v 0-9 rate this pic for the specified Set

          */

         public        void        addFilter(String setName, int v) {

                 filters.put(setName, new Integer(v));

         }

         /** Add this value to the Filter for this set/size.

          * @param set The set to add.

          * @param size The size to add.

          * @param v 0-9 rate this pic for the specified Set/size.

          */

         public        void        addFilter(String set, int size, int v) {

                 String        s = set + "_" + size;

                 addFilter(s, v);

         }

         /** Fetch the time that this filter was last edited.

          * @return The Date of the last edit.

          */

         public        Date        getDate() { return(date); }

         /** Set the timestamp for this filter.

          * @param time The date in milliseconds.

          */

         public void setTime(long time) {

                 this.date.setTime(time);

         }

         /** Set the timestamp for this filter.

          * @param date to set this filter to.

          */

         public void setTime(Date date) {

                 this.date.setTime(date.getTime());

         }

         public void setTimeNow() {

                 this.date = new Date();

         }

 }