001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.fukurou.util;
017
018import org.opengion.fukurou.system.OgRuntimeException ;                         // 6.4.2.0 (2016/01/29)
019import java.awt.Color;
020import java.util.LinkedHashMap;                                                                         // 6.4.6.1 (2016/06/03)
021import java.util.Map;
022import java.util.Locale ;
023
024import static org.opengion.fukurou.system.HybsConst.CR;                         // 6.1.0.0 (2014/12/26) refactoring
025
026/**
027 * ColorMap.java は、共通的に使用される Color関連メソッドを集約した、クラスです。
028 * StringUtil から、Color関係の部分を独立させました。
029 *
030 * カラー文字列は、java.awt.Color static 定義色、CSS1 / HTML3–4 / VGA の色名称、
031 * X11の色名称 が指定できます。
032 *
033 * カラー番号は、0:BLUE,1:CYAN,2:GRAY,3:GREEN,4:LIGHT_GRAY,
034 * 5:MAGENTA,6:DARK_GRAY,7:ORANGE,8:PINK,9:RED,10:YELLOW 
035 * となっており、配列数を超えると、0:BLUE に戻ります。
036 *
037 * @og.group ユーティリティ
038 * @og.rev 6.0.2.1 (2014/09/26) 新規作成
039 * @og.rev 6.4.3.3 (2016/03/04) ViewForm_ImageTimeBar#FlgColorMap 内部クラスから機能移動
040 *
041 * @version  6.0
042 * @author       Kazuhiko Hasegawa
043 * @since    JDK8.0,
044 */
045public final class ColorMap {
046        // 6.4.3.3 (2016/03/04) ViewForm_ImageTimeBar#FlgColorMap 内部クラスから移動
047        private static final Color[] CLR_ARY = new Color[] {
048                        Color.BLUE      ,Color.CYAN   ,Color.GRAY ,Color.GREEN ,Color.LIGHT_GRAY ,Color.MAGENTA ,
049                        Color.DARK_GRAY ,Color.ORANGE ,Color.PINK ,Color.RED   ,Color.YELLOW
050        };
051
052        // 4.0.3.0 (2007/12/26) 色コードにPURPLE を追加
053        // 5.7.8.0 (2014/07/04) 透明追加
054        /** staticイニシャライザ後、読み取り専用にするので、ConcurrentHashMap を使用しません。 */
055        private static final Map<String,Color> CLR_MAP;
056        static {
057                CLR_MAP = new LinkedHashMap<>();                                                        // 6.4.6.1 (2016/06/03) 登録順をキープします。
058                // java.awt.Color static 定義色
059                CLR_MAP.put( "BLUE"                     ,Color.BLUE                     );
060                CLR_MAP.put( "CYAN"                     ,Color.CYAN                     );
061                CLR_MAP.put( "GRAY"                     ,Color.GRAY                     );
062                CLR_MAP.put( "GREEN"            ,Color.GREEN            );
063                CLR_MAP.put( "LIGHTGRAY"        ,Color.LIGHT_GRAY       );
064                CLR_MAP.put( "MAGENTA"          ,Color.MAGENTA          );
065                CLR_MAP.put( "DARKGRAY"         ,Color.DARK_GRAY        );
066                CLR_MAP.put( "ORANGE"           ,Color.ORANGE           );
067                CLR_MAP.put( "PINK"                     ,Color.PINK                     );
068                CLR_MAP.put( "RED"                      ,Color.RED                      );
069                CLR_MAP.put( "YELLOW"           ,Color.YELLOW           );
070
071                CLR_MAP.put( "WHITE"            ,Color.WHITE            );
072                CLR_MAP.put( "BLACK"            ,Color.BLACK            );
073                CLR_MAP.put( "TRANSPARENT"      ,new Color( 255,255,255,0 )     );              // 5.7.8.0 (2014/07/04) 透明追加
074
075                // 6.0.2.1 (2014/09/26) CSS1 / HTML3–4 / VGA の色名称 追加
076                CLR_MAP.put( "LIME"                     ,Color.decode( "#00FF00" )      );
077                CLR_MAP.put( "AQUA"                     ,Color.decode( "#00FFFF" )      );
078                CLR_MAP.put( "SILVER"           ,Color.decode( "#C0C0C0" )      );
079                CLR_MAP.put( "MAROON"           ,Color.decode( "#800000" )      );              // X11では、#B03060
080                CLR_MAP.put( "OLIVE"            ,Color.decode( "#808000" )      );
081                CLR_MAP.put( "TEAL"                     ,Color.decode( "#008080" )      );
082                CLR_MAP.put( "NAVY"                     ,Color.decode( "#000080" )      );
083                CLR_MAP.put( "FUCHSIA"          ,Color.decode( "#FF00FF" )      );
084                CLR_MAP.put( "PURPLE"           ,Color.decode( "#800080" )      );              // X11では、#A020F0
085
086                // 6.0.2.1 (2014/09/26) X11の色名称 追加
087                CLR_MAP.put( "ALICEBLUE"                        ,Color.decode( "#F0F8FF" )      );
088                CLR_MAP.put( "ANTIQUEWHITE"                     ,Color.decode( "#FAEBD7" )      );
089                CLR_MAP.put( "AQUAMARINE"                       ,Color.decode( "#7FFFD4" )      );
090                CLR_MAP.put( "AZURE"                            ,Color.decode( "#F0FFFF" )      );
091                CLR_MAP.put( "BEIGE"                            ,Color.decode( "#F5F5DC" )      );
092                CLR_MAP.put( "BISQUE"                           ,Color.decode( "#FFE4C4" )      );
093                CLR_MAP.put( "BLANCHEDALMOND"           ,Color.decode( "#FFEBCD" )      );
094                CLR_MAP.put( "BLUEVIOLET"                       ,Color.decode( "#8A2BE2" )      );
095                CLR_MAP.put( "BROWN"                            ,Color.decode( "#A52A2A" )      );
096                CLR_MAP.put( "BURLYWOOD"                        ,Color.decode( "#DEB887" )      );
097                CLR_MAP.put( "CADETBLUE"                        ,Color.decode( "#5F9EA0" )      );
098                CLR_MAP.put( "CHARTREUSE"                       ,Color.decode( "#7FFF00" )      );
099                CLR_MAP.put( "CHOCOLATE"                        ,Color.decode( "#D2691E" )      );
100                CLR_MAP.put( "CORAL"                            ,Color.decode( "#FF7F50" )      );
101                CLR_MAP.put( "CORNFLOWERBLUE"           ,Color.decode( "#6495ED" )      );
102                CLR_MAP.put( "CORNSILK"                         ,Color.decode( "#FFF8DC" )      );
103                CLR_MAP.put( "CRIMSON"                          ,Color.decode( "#DC143C" )      );
104                CLR_MAP.put( "DARKBLUE"                         ,Color.decode( "#00008B" )      );
105                CLR_MAP.put( "DARKCYAN"                         ,Color.decode( "#008B8B" )      );
106                CLR_MAP.put( "DARKGOLDENROD"            ,Color.decode( "#B8860B" )      );
107                CLR_MAP.put( "DARKGREEN"                        ,Color.decode( "#006400" )      );
108                CLR_MAP.put( "DARKKHAKI"                        ,Color.decode( "#BDB76B" )      );
109                CLR_MAP.put( "DARKMAGENTA"                      ,Color.decode( "#8B008B" )      );
110                CLR_MAP.put( "DARKOLIVEGREEN"           ,Color.decode( "#556B2F" )      );
111                CLR_MAP.put( "DARKORANGE"                       ,Color.decode( "#FF8C00" )      );
112                CLR_MAP.put( "DARKORCHID"                       ,Color.decode( "#9932CC" )      );
113                CLR_MAP.put( "DARKRED"                          ,Color.decode( "#8B0000" )      );
114                CLR_MAP.put( "DARKSALMON"                       ,Color.decode( "#E9967A" )      );
115                CLR_MAP.put( "DARKSEAGREEN"                     ,Color.decode( "#8FBC8F" )      );
116                CLR_MAP.put( "DARKSLATEBLUE"            ,Color.decode( "#483D8B" )      );
117                CLR_MAP.put( "DARKSLATEGRAY"            ,Color.decode( "#2F4F4F" )      );
118                CLR_MAP.put( "DARKTURQUOISE"            ,Color.decode( "#00CED1" )      );
119                CLR_MAP.put( "DARKVIOLET"                       ,Color.decode( "#9400D3" )      );
120                CLR_MAP.put( "DEEPPINK"                         ,Color.decode( "#FF1493" )      );
121                CLR_MAP.put( "DEEPSKYBLUE"                      ,Color.decode( "#00BFFF" )      );
122                CLR_MAP.put( "DIMGRAY"                          ,Color.decode( "#696969" )      );
123                CLR_MAP.put( "DODGERBLUE"                       ,Color.decode( "#1E90FF" )      );
124                CLR_MAP.put( "FIREBRICK"                        ,Color.decode( "#B22222" )      );
125                CLR_MAP.put( "FLORALWHITE"                      ,Color.decode( "#FFFAF0" )      );
126                CLR_MAP.put( "FORESTGREEN"                      ,Color.decode( "#228B22" )      );
127                CLR_MAP.put( "GAINSBORO"                        ,Color.decode( "#DCDCDC" )      );
128                CLR_MAP.put( "GHOSTWHITE"                       ,Color.decode( "#F8F8FF" )      );
129                CLR_MAP.put( "GOLD"                                     ,Color.decode( "#FFD700" )      );
130                CLR_MAP.put( "GOLDENROD"                        ,Color.decode( "#DAA520" )      );
131                CLR_MAP.put( "GREENYELLOW"                      ,Color.decode( "#ADFF2F" )      );
132                CLR_MAP.put( "HONEYDEW"                         ,Color.decode( "#F0FFF0" )      );
133                CLR_MAP.put( "HOTPINK"                          ,Color.decode( "#FF69B4" )      );
134                CLR_MAP.put( "INDIANRED"                        ,Color.decode( "#CD5C5C" )      );
135                CLR_MAP.put( "INDIGO"                           ,Color.decode( "#4B0082" )      );
136                CLR_MAP.put( "IVORY"                            ,Color.decode( "#FFFFF0" )      );
137                CLR_MAP.put( "KHAKI"                            ,Color.decode( "#F0E68C" )      );
138                CLR_MAP.put( "LAVENDER"                         ,Color.decode( "#E6E6FA" )      );
139                CLR_MAP.put( "LAVENDERBLUSH"            ,Color.decode( "#FFF0F5" )      );
140                CLR_MAP.put( "LAWNGREEN"                        ,Color.decode( "#7CFC00" )      );
141                CLR_MAP.put( "LEMONCHIFFON"                     ,Color.decode( "#FFFACD" )      );
142                CLR_MAP.put( "LIGHTBLUE"                        ,Color.decode( "#ADD8E6" )      );
143                CLR_MAP.put( "LIGHTCORAL"                       ,Color.decode( "#F08080" )      );
144                CLR_MAP.put( "LIGHTCYAN"                        ,Color.decode( "#E0FFFF" )      );
145                CLR_MAP.put( "LIGHTGOLDENRODYELLOW"     ,Color.decode( "#FAFAD2" )      );
146                CLR_MAP.put( "LIGHTGREEN"                       ,Color.decode( "#90EE90" )      );
147                CLR_MAP.put( "LIGHTPINK"                        ,Color.decode( "#FFB6C1" )      );
148                CLR_MAP.put( "LIGHTSALMON"                      ,Color.decode( "#FFA07A" )      );
149                CLR_MAP.put( "LIGHTSEAGREEN"            ,Color.decode( "#20B2AA" )      );
150                CLR_MAP.put( "LIGHTSKYBLUE"                     ,Color.decode( "#87CEFA" )      );
151                CLR_MAP.put( "LIGHTSLATEGRAY"           ,Color.decode( "#778899" )      );
152                CLR_MAP.put( "LIGHTSTEELBLUE"           ,Color.decode( "#B0C4DE" )      );
153                CLR_MAP.put( "LIGHTYELLOW"                      ,Color.decode( "#FFFFE0" )      );
154                CLR_MAP.put( "LIMEGREEN"                        ,Color.decode( "#32CD32" )      );
155                CLR_MAP.put( "LINEN"                            ,Color.decode( "#FAF0E6" )      );
156                CLR_MAP.put( "MEDIUMAQUAMARINE"         ,Color.decode( "#66CDAA" )      );
157                CLR_MAP.put( "MEDIUMBLUE"                       ,Color.decode( "#0000CD" )      );
158                CLR_MAP.put( "MEDIUMORCHID"                     ,Color.decode( "#BA55D3" )      );
159                CLR_MAP.put( "MEDIUMPURPLE"                     ,Color.decode( "#9370DB" )      );
160                CLR_MAP.put( "MEDIUMSEAGREEN"           ,Color.decode( "#3CB371" )      );
161                CLR_MAP.put( "MEDIUMSLATEBLUE"          ,Color.decode( "#7B68EE" )      );
162                CLR_MAP.put( "MEDIUMSPRINGGREEN"        ,Color.decode( "#00FA9A" )      );
163                CLR_MAP.put( "MEDIUMTURQUOISE"          ,Color.decode( "#48D1CC" )      );
164                CLR_MAP.put( "MEDIUMVIOLETRED"          ,Color.decode( "#C71585" )      );
165                CLR_MAP.put( "MIDNIGHTBLUE"                     ,Color.decode( "#191970" )      );
166                CLR_MAP.put( "MINTCREAM"                        ,Color.decode( "#F5FFFA" )      );
167                CLR_MAP.put( "MISTYROSE"                        ,Color.decode( "#FFE4E1" )      );
168                CLR_MAP.put( "MOCCASIN"                         ,Color.decode( "#FFE4B5" )      );
169                CLR_MAP.put( "NAVAJOWHITE"                      ,Color.decode( "#FFDEAD" )      );
170                CLR_MAP.put( "OLDLACE"                          ,Color.decode( "#FDF5E6" )      );
171                CLR_MAP.put( "OLIVEDRAB"                        ,Color.decode( "#6B8E23" )      );
172                CLR_MAP.put( "ORANGERED"                        ,Color.decode( "#FF4500" )      );
173                CLR_MAP.put( "ORCHID"                           ,Color.decode( "#DA70D6" )      );
174                CLR_MAP.put( "PALEGOLDENROD"            ,Color.decode( "#EEE8AA" )      );
175                CLR_MAP.put( "PALEGREEN"                        ,Color.decode( "#98FB98" )      );
176                CLR_MAP.put( "PALETURQUOISE"            ,Color.decode( "#AFEEEE" )      );
177                CLR_MAP.put( "PALEVIOLETRED"            ,Color.decode( "#DB7093" )      );
178                CLR_MAP.put( "PAPAYAWHIP"                       ,Color.decode( "#FFEFD5" )      );
179                CLR_MAP.put( "PEACHPUFF"                        ,Color.decode( "#FFDAB9" )      );
180                CLR_MAP.put( "PERU"                                     ,Color.decode( "#CD853F" )      );
181                CLR_MAP.put( "PLUM"                                     ,Color.decode( "#DDA0DD" )      );
182                CLR_MAP.put( "POWDERBLUE"                       ,Color.decode( "#B0E0E6" )      );
183                CLR_MAP.put( "ROSYBROWN"                        ,Color.decode( "#BC8F8F" )      );
184                CLR_MAP.put( "ROYALBLUE"                        ,Color.decode( "#4169E1" )      );
185                CLR_MAP.put( "SADDLEBROWN"                      ,Color.decode( "#8B4513" )      );
186                CLR_MAP.put( "SALMON"                           ,Color.decode( "#FA8072" )      );
187                CLR_MAP.put( "SANDYBROWN"                       ,Color.decode( "#F4A460" )      );
188                CLR_MAP.put( "SEAGREEN"                         ,Color.decode( "#2E8B57" )      );
189                CLR_MAP.put( "SEASHELL"                         ,Color.decode( "#FFF5EE" )      );
190                CLR_MAP.put( "SIENNA"                           ,Color.decode( "#A0522D" )      );
191                CLR_MAP.put( "SKYBLUE"                          ,Color.decode( "#87CEEB" )      );
192                CLR_MAP.put( "SLATEBLUE"                        ,Color.decode( "#6A5ACD" )      );
193                CLR_MAP.put( "SLATEGRAY"                        ,Color.decode( "#708090" )      );
194                CLR_MAP.put( "SNOW"                                     ,Color.decode( "#FFFAFA" )      );
195                CLR_MAP.put( "SPRINGGREEN"                      ,Color.decode( "#00FF7F" )      );
196                CLR_MAP.put( "STEELBLUE"                        ,Color.decode( "#4682B4" )      );
197                CLR_MAP.put( "TAN"                                      ,Color.decode( "#D2B48C" )      );
198                CLR_MAP.put( "THISTLE"                          ,Color.decode( "#D8BFD8" )      );
199                CLR_MAP.put( "TOMATO"                           ,Color.decode( "#FF6347" )      );
200                CLR_MAP.put( "TURQUOISE"                        ,Color.decode( "#40E0D0" )      );
201                CLR_MAP.put( "VIOLET"                           ,Color.decode( "#EE82EE" )      );
202                CLR_MAP.put( "WHEAT"                            ,Color.decode( "#F5DEB3" )      );
203                CLR_MAP.put( "WHITESMOKE"                       ,Color.decode( "#F5F5F5" )      );
204                CLR_MAP.put( "YELLOWGREEN"                      ,Color.decode( "#9ACD32" )      );
205
206                // 6.4.4.1 (2016/03/18)
207                for( int i=0; i<CLR_ARY.length; i++ ) {
208                        CLR_MAP.put( String.valueOf( i ) ,CLR_ARY[i] );
209                }
210        }
211
212        /**
213         *      デフォルトコンストラクターをprivateにして、
214         *      オブジェクトの生成をさせないようにする。
215         *
216         */
217        private ColorMap() {}
218
219        /**
220         * カラーキーワードより、Colorオブジェクトを作成します。
221         *
222         * 指定文字列は、java.awt.Color クラスのstatic フィールド名で指定します。
223         * BLACK , BLUE , CYAN , DARK_GRAY , GRAY , GREEN , LIGHT_GRAY ,
224         * MAGENTA , ORANGE , PINK , RED , WHITE , YELLOW , PURPLE , TRANSPARENT(透明) が指定できます。
225         * 
226         * 6.0.2.1 (2014/09/26) 以降では、CSS1/HTML3–4/VGA の色名称として、
227         * LIME , AQUA , SILVER , MAROON , OLIVE , TEAL , NAVY , FUCHSIA を追加。
228         * それと、X11の色名称 を追加しました。
229         * 
230         * また、先頭に、# を付ける事で、#XXXXXX形式の16bitRGB表記 でも指定可能です。
231         * static フィールド名のMapを管理していますが、存在しない場合は、エラーになります。
232         *
233         * @og.rev 3.8.9.1 (2007/06/29) 新規作成
234         * @og.rev 4.1.1.0 (2008/02/04) CLR_MAP に存在しない場合はエラーにします。
235         * @og.rev 6.0.2.1 (2014/09/26) CSS1/HTML3–4/VGA の色名称 , X11の色名称 追加
236         * @og.rev 6.3.9.0 (2015/11/06) valueのnullチェックの仕方が間違っていた。
237         * @og.rev 6.4.6.1 (2016/06/03) 色番号の取得も対応しておきます。
238         *
239         * @param       value java.awt.Color フィールドを示す文字列または、#XXXXXX形式の16bitRGB表記
240         *
241         * @return      Colorオブジェクト
242         * @see         java.awt.Color#BLACK
243         */
244        public static Color getColorInstance( final String value ) {
245                // 6.3.9.0 (2015/11/06) valueのnullチェックの仕方が間違っていた。
246                if( value == null || value.length() == 0 ) {
247                        final String errMsg = "色コードが指定されていません。" + CR                    // 6.4.6.1 (2016/06/03)
248                                                + "ColorMap=" + CLR_MAP.keySet().toString();
249                        throw new OgRuntimeException( errMsg );
250                }
251
252                Color clr = null ;                      // 6.4.6.1 (2016/06/03) 色番号で、再設定しているため、final をはずす。
253
254                if( value.charAt(0) == '#' ) {
255                        try {
256                                clr = Color.decode( value );
257                        }
258                        catch( final NumberFormatException ex ) {                       // 10進、8進、および16進の整数値に変換できない場合
259                                final String errMsg = "指定の色コードのフォーマットが異なります Color=[" + value + "]" + CR
260                                                        + "ColorMap=" + CLR_MAP.keySet().toString();
261                                throw new OgRuntimeException( errMsg,ex );
262                        }
263                }
264                else {
265                        // "_"を削除するのは、LIGHT_GRAY などの表記を統一するため。
266                        final String val = value.replaceAll( "_" , "" ).toUpperCase(Locale.JAPAN);
267                        clr = CLR_MAP.get( val );
268                        if( clr == null ) {
269                                // 6.4.6.1 (2016/06/03) 色番号の取得も対応しておきます。
270                                // 0 ~ 10 は登録済みなので、それ以降の数字の繰り返しが出来ない
271                                try {
272                                        clr = getColorInstance( Integer.parseInt( value ) );
273                                }
274                                catch( final NumberFormatException ex ) {                       // 数字ではない value をパースしているので、この、Exception は伝播不要。
275                                        final String errMsg = "指定の色コードは使用できません Color=[" + value + "]" + CR
276                                                                + "ColorMap=" + CLR_MAP.keySet().toString();
277                                        throw new OgRuntimeException( errMsg,ex );
278                                }
279                        }
280                }
281
282                return clr;
283        }
284
285        /**
286         * 指定の番号に対応した、色オブジェクトを返します。
287         *
288         * 以前は、ViewForm_ImageTimeBar#uniqColor() メソッドで、ユニークな色を
289         * 返していました。配列を超えると、自動的にランダムな色を出していましたが、
290         * 実質的にそのような色を出すのではなく、番号に応じて、繰り返すことにします。
291         * 割り当てた色の番号は、0:BLUE,1:CYAN,2:GRAY,3:GREEN,4:LIGHT_GRAY,
292         * 5:MAGENTA,6:DARK_GRAY,7:ORANGE,8:PINK,9:RED,10:YELLOW 
293         * となっており、それを超えると、0:BLUE に戻ります。
294         *
295         * @og.rev 6.4.3.3 (2016/03/04) ViewForm_ImageTimeBar#uniqColor() メソッドから移動。
296         *
297         * @param       no 内部で管理している色番号
298         * @return      色オブジェクト
299         */
300        public static Color getColorInstance( final int no ) {
301                return CLR_ARY[no % CLR_ARY.length];
302
303        }
304
305        /**
306         * 内部で管理している ColorMap のキー配列を返します。
307         *
308         * @og.rev 6.0.2.1 (2014/09/26) 新規追加
309         *
310         * @return      キー配列
311         * @og.rtnNotNull
312         */
313        public static String[] getColorKeys() {
314                return CLR_MAP.keySet().toArray( new String[CLR_MAP.size()] );
315        }
316}