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.xml;
017
018import java.util.concurrent.ConcurrentMap;                                                      // 6.4.3.3 (2016/03/04)
019
020import static org.opengion.fukurou.system.HybsConst.BUFFER_SMALL;               // 6.1.0.0 (2014/12/26) refactoring
021
022/**
023 * JSP/XMLファイルを読み取って、構築される最上位の OGDocument オブジェクト を定義します。
024 *
025 * JspSaxParser での read/write で構築される トップレベルの OGNode になります。
026 *
027 * @og.rev 5.1.8.0 (2010/07/01) 新規作成
028 *
029 * @version  5.0
030 * @author   Kazuhiko Hasegawa
031 * @since    JDK6.0,
032 */
033public class OGDocument extends OGNode {
034        /** 6.4.3.1 (2016/02/12) 作成元のMapを、HashMap から ConcurrentHashMap に置き換え。  */
035        private ConcurrentMap<String,OGElement> idMap   ;               // 5.1.9.0 (2010/08/01)
036        private String file                     ;
037        private String encode           = "UTF-8";              // 基本的には、XML は、UTF-8 で扱うのが良い。
038        private String nameSpace        ;                               // 5.2.1.0 (2010/10/01) トップエレメントの名前空間のキャッシュ
039
040        /**
041         * デフォルトコンストラクター
042         *
043         * NodeType を Document に設定し、デフォルトの OGNode を構築します。
044         *
045         */
046        public OGDocument() {
047                super();
048                setNodeType( OGNodeType.Document );
049        }
050
051        /**
052         * 最上位の エレメントを返します。
053         *
054         * ノードが、まだ登録されていない、または、エレメントノードでない場合は、null が返されます。
055         *
056         * @return      最上位のエレメント
057         */
058        public OGElement getTopElement() {
059                if( nodeSize() > 0 ) {
060                        final OGNode node = getNode( 0 );
061                        if( node.getNodeType() == OGNodeType.Element ) {
062                                // 6.0.2.5 (2014/10/31) refactoring: getNodeType でチェックしているので間違いはないが、findBugs対応
063                                if( node instanceof OGElement ) {
064                                        return (OGElement)node;
065                                }
066                                else {                  // 基本、あり得ない。
067                                        final String errMsg = "この、OGNode は、OGElement のインスタンスではありません。" ;
068                                        System.err.println( "WARNING:" + errMsg );
069                                }
070                        }
071                }
072                return null ;
073        }
074
075        /**
076         * このドキュメントの読み込み元のファイル名をセットします。
077         *
078         * ドキュメントの処理の可否を判断したり、デバッグ時に使用します。
079         *
080         * @param       name    読み込んだファイル名
081         */
082        public void setFilename( final String name ) {
083                file = name;
084        }
085
086        /**
087         * このドキュメントの読み込み元のファイル名を取得します。
088         *
089         * ドキュメントの処理の可否を判断したり、デバッグ時に使用します。
090         *
091         * @return      読み込んだファイル名
092         */
093        public String getFilename() {
094                return file;
095        }
096
097        /**
098         * このドキュメントのXML宣言のエンコード属性をセットします(初期値:UTF-8)。
099         *
100         * ドキュメントの出力時の XML 宣言に付与します。
101         * null の設定が可能です。 null をセットすると、XML宣言出力時に、
102         * encode 属性になにもセットしません。
103         *
104         * @param       encode  XML宣言のエンコード属性
105         */
106        public void setEncode( final String encode ) {
107                this.encode = encode;
108        }
109
110        /**
111         * このドキュメントのXML宣言のエンコード属性を取得します(初期値:UTF-8)。
112         *
113         * ドキュメントの出力時の XML 宣言に付与します。
114         * encode 属性になにもセットされていない場合は、null が返されます。
115         *
116         * @return      XML宣言のエンコード属性
117         */
118        public String getEncode() {
119                return encode;
120        }
121
122        /**
123         * このドキュメントの "hybs-taglib.tld" の nameSpace(名前空間)を返します。
124         *
125         * 通常は、標準エンジンの場合は "og" になります。
126         * 社内システムの場合は、互換性の関係から、"mis" になっています。
127         * Ver3 の時代は、"mis-taglib.tld" だったので、この処理はできません。
128         *
129         * @og.rev 5.2.1.0 (2010/10/01) 新規作成
130         *
131         * @return      名前空間(存在しないときは、ゼロ文字列)
132         */
133        public String getNameSpace() {
134                if( nameSpace != null ) { return nameSpace; }
135
136                nameSpace = "" ;                // 存在しないときは、ゼロ文字列になる。
137                final OGElement ele = getTopElement();
138                if( ele != null ) {
139                        final OGAttributes attri = ele.getOGAttributes();
140                        for( int i=0; i<attri.size(); i++ ) {
141                                if( "hybs-taglib.tld".equals( attri.getVal(i) ) ) {
142                                        final String key = attri.getKey(i);                     // xmlns:og , xmlns:mis などのはず
143                                        final int cm = key.indexOf( ':' );
144                                        nameSpace = key.substring( cm+1 );                      // : は削除している。"og" など
145                                        break;
146                                }
147                        }
148                }
149                return nameSpace;
150        }
151
152        /**
153         * このドキュメントに含まれる id に対する、エレメントのマップをセットします。
154         *
155         * id 指定されているエレメントは、特別にキャッシュされます。
156         * また、ドキュメント中には、id は、一意に設定されていることとします。
157         * 複数、おなじ id が存在する場合は、(保障されませんが)性質上、最後に登録された
158         * エレメントが、設定されます。
159         *
160         * ※ 6.4.3.1 (2016/02/12) で、セットするMapを、ConcurrentHashMap に置き換えているため、
161         *    key,value ともに、not null制限が入っています。
162         * @og.rev 6.4.3.3 (2016/03/04) ConcurrentHashMap を受け取ることを明確にするため、I/FをConcurrentMapに変更します。
163         *
164         * @param       map     エレメントのマップ
165         */
166        public void setIdMap( final ConcurrentMap<String,OGElement> map ) {
167                idMap = map;
168        }
169
170        /**
171         * 指定の id に対するエレメントを返します。
172         *
173         * id に対するエレメントが存在しない場合は、null が返されます。
174         *
175         * @og.rev 6.4.3.3 (2016/03/04) ConcurrentHashMap の not null制限のチェック追加
176         *
177         * @param       id      指定のID
178         *
179         * @return      OGエレメント
180         */
181        public OGElement getElementById( final String id ) {
182                OGElement ele = null;
183
184                if( idMap != null && id != null ) { ele = idMap.get( id ); }
185
186                return ele ;
187        }
188
189        /**
190         * オブジェクトの文字列表現を返します。
191         *
192         * ここでは、ドキュメントにXML宣言をつけた状態の文字列を返します。
193         * 基本的には、ドキュメントには、一つだけ エレメントを含むことになります。
194         * よって、XML宣言をつけない状態で出力する場合は、#getTopElement() で
195         * エレメントを取得して、それを、toString() してください。
196         *
197         * @og.rev 5.6.4.4 (2013/05/31) 改行3つを改行2つに置換します。
198         *
199         * @return      このオブジェクトの文字列表現
200         * @og.rtnNotNull
201         * @see OGNode#toString()
202         * @see #getTopElement()
203         */
204        @Override
205        public String toString() {
206                final StringBuilder buf = new StringBuilder( BUFFER_SMALL )
207                        .append( "<?xml version=\"1.0\"" );
208                if( encode != null ) {
209                        buf.append( " encoding=\"" ).append( encode ).append( '"' );            // 6.0.2.5 (2014/10/31) char を append する。
210                }
211                buf.append( "?>" ).append( CR ).append( super.toString() );
212
213                return buf.toString().replaceAll( CR+CR+CR , CR+CR ) ;                  // 改行3つを改行2つに置換します。
214        }
215}