package uk.ac.ebi.xchars.palette;

 import java.io.Serializable;

 import java.util.ArrayList;

 import java.util.Collections;

 import java.util.Enumeration;

 import java.util.Iterator;

 import java.util.List;

 import java.util.ResourceBundle;

 import uk.ac.ebi.xchars.SpecialCharacters;

 import uk.ac.ebi.xchars.domain.XCharsClass;

 public class XCharsPalette implements Serializable {

         private static final long serialVersionUID = -6882923092921136526L;

         private List<XCharsPaletteElement> favouriteTagElements = new ArrayList<XCharsPaletteElement>();

         private List<XCharsPaletteClass> xcharsPaletteClasses = new ArrayList<XCharsPaletteClass>();

         private static List<String> unclosedTags = new ArrayList<String>();

         private static List<String> favouriteTags = new ArrayList<String>();

         static {

                 try {

                         ResourceBundle bundle = ResourceBundle.getBundle("xcharsUnclosed");

                         ResourceBundle favourite = ResourceBundle.getBundle("xcharsFavourites");

                         Enumeration<String> keys = bundle.getKeys();

                         while ( keys.hasMoreElements() ) {

                                 unclosedTags.add(keys.nextElement());

                         }

                         // Important to preserver the order

                         int counter = 1;

                         while ( counter < 30 ) {

                                 String value = favourite.getString(String.valueOf(counter));

                                 if ( value != null )

                                         favouriteTags.add(value);

                                 else

                                         counter = 30;

                                 ++counter;

                         }

                 } catch ( Exception e ) {

                         System.err.println("XCharsPalette: unable to load favourites");

                 }

         }

         public XCharsPalette (SpecialCharacters sc) {

                 getXmlElements(sc);

         }

         public List<XCharsPaletteClass> getXcharsPaletteClasses () {

                 return xcharsPaletteClasses;

         }

         /**

          * Gets all the specialCharacter XML elements for the character classes.

          *

          * @param sc

          */

         private void getXmlElements (SpecialCharacters sc) {

                 //create XCharsPaletteClass Objects which contain the name of the class, the corresponding elements

                 //and their Xml- Default- and Ascii Encoding

                 //add all XCharsPalette Objects to the xcharsPaletteClasses list

                 for ( Iterator classTypes = sc.getCharacterClasses().keySet().iterator(); classTypes.hasNext(); )

                 {

                         String classType = (String) classTypes.next();

                         XCharsClass xcharclass = (XCharsClass) sc.getCharacterClasses().get(classType);

                         XCharsPaletteClass xcharsPaletteClass = new XCharsPaletteClass(sc, xcharclass);

                         xcharsPaletteClasses.add(xcharsPaletteClass);

                 }

                 for ( Iterator classTypes = sc.getFormattingClasses().keySet().iterator(); classTypes.hasNext(); )

                 {

                         String classType = (String) classTypes.next();

                         XCharsClass xcharclass = (XCharsClass) sc.getFormattingClasses().get(classType);

                         XCharsPaletteClass xcharsPaletteClass = new XCharsPaletteClass(sc, xcharclass);

                         xcharsPaletteClasses.add(xcharsPaletteClass);

                 }

                 Collections.sort(xcharsPaletteClasses);

         }

         /**

          * Returns the list of the curators favourite tags. Is dependent on the resources,

          * xcharsFavourites.properties

          *

          * @return list of favourite tags

          */

         public boolean isFavouriteTag (String completeTag) {

                 return favouriteTags.contains(completeTag);

         }

         public List<XCharsPaletteElement> getFavouriteTagElements () {

                 return favouriteTagElements;

         }

         public List<String> getFavouriteTags () {

                 return favouriteTags;

         }

         // -------------------------------- STATIC METHODS -----------------------//

         /**

          * Returns true if this classType contains tags which should not be closed

          * in a single element even though it contains no character within the tag.<br/>

          * For example: <ital> should contain something between the two tags

          * instead of <ital/>

          *

          * @return the list of tags which should be closed within a tag.

          */

         public static boolean isUnclosedTag (String xcharClassType) {

                 return unclosedTags.contains(xcharClassType);

         }

 }