001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.csv;
014
015import java.util.*;
016import java.util.concurrent.*;
017
018import org.apache.juneau.*;
019import org.apache.juneau.annotation.*;
020import org.apache.juneau.collections.*;
021import org.apache.juneau.parser.*;
022
023/**
024 * TODO - Work in progress.  CSV parser.
025 */
026@ConfigurableContext
027public class CsvParser extends ReaderParser implements CsvMetaProvider, CsvCommon {
028
029   //-------------------------------------------------------------------------------------------------------------------
030   // Configurable properties
031   //-------------------------------------------------------------------------------------------------------------------
032
033   static final String PREFIX = "CsvParser";
034
035   //-------------------------------------------------------------------------------------------------------------------
036   // Predefined instances
037   //-------------------------------------------------------------------------------------------------------------------
038
039   /** Default parser, all default settings.*/
040   public static final CsvParser DEFAULT = new CsvParser(PropertyStore.DEFAULT);
041
042
043   //-------------------------------------------------------------------------------------------------------------------
044   // Instance
045   //-------------------------------------------------------------------------------------------------------------------
046
047   private final Map<ClassMeta<?>,CsvClassMeta> csvClassMetas = new ConcurrentHashMap<>();
048   private final Map<BeanPropertyMeta,CsvBeanPropertyMeta> csvBeanPropertyMetas = new ConcurrentHashMap<>();
049
050   /**
051    * Constructor.
052    *
053    * @param ps The property store containing all the settings for this object.
054    */
055   public CsvParser(PropertyStore ps) {
056      super(ps, "text/csv");
057   }
058
059   @Override /* Context */
060   public CsvParserBuilder builder() {
061      return new CsvParserBuilder(getPropertyStore());
062   }
063
064   /**
065    * Instantiates a new clean-slate {@link CsvParserBuilder} object.
066    *
067    * <p>
068    * Note that this method creates a builder initialized to all default settings, whereas {@link #builder()} copies
069    * the settings of the object called on.
070    *
071    * @return A new {@link CsvParserBuilder} object.
072    */
073   public static CsvParserBuilder create() {
074      return new CsvParserBuilder();
075   }
076
077   @Override /* Parser */
078   public CsvParserSession createSession() {
079      return createSession(createDefaultSessionArgs());
080   }
081
082   @Override /* Parser */
083   public CsvParserSession createSession(ParserSessionArgs args) {
084      return new CsvParserSession(this, args);
085   }
086
087   //-----------------------------------------------------------------------------------------------------------------
088   // Extended metadata
089   //-----------------------------------------------------------------------------------------------------------------
090
091   @Override /* CsvMetaProvider */
092   public CsvClassMeta getCsvClassMeta(ClassMeta<?> cm) {
093      CsvClassMeta m = csvClassMetas.get(cm);
094      if (m == null) {
095         m = new CsvClassMeta(cm, this);
096         csvClassMetas.put(cm, m);
097      }
098      return m;
099   }
100
101   @Override /* CsvMetaProvider */
102   public CsvBeanPropertyMeta getCsvBeanPropertyMeta(BeanPropertyMeta bpm) {
103      if (bpm == null)
104         return CsvBeanPropertyMeta.DEFAULT;
105      CsvBeanPropertyMeta m = csvBeanPropertyMetas.get(bpm);
106      if (m == null) {
107         m = new CsvBeanPropertyMeta(bpm.getDelegateFor(), this);
108         csvBeanPropertyMetas.put(bpm, m);
109      }
110      return m;
111   }
112
113   //-----------------------------------------------------------------------------------------------------------------
114   // Other methods
115   //-----------------------------------------------------------------------------------------------------------------
116
117   @Override /* Context */
118   public OMap toMap() {
119      return super.toMap()
120         .a("CsvParser", new DefaultFilteringOMap());
121   }
122}