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.parser.*;
021
022/**
023 * TODO - Work in progress.  CSV parser.
024 */
025@ConfigurableContext
026public class CsvParser extends ReaderParser implements CsvMetaProvider, CsvCommon {
027
028   //-------------------------------------------------------------------------------------------------------------------
029   // Configurable properties
030   //-------------------------------------------------------------------------------------------------------------------
031
032   static final String PREFIX = "CsvParser";
033
034   //-------------------------------------------------------------------------------------------------------------------
035   // Predefined instances
036   //-------------------------------------------------------------------------------------------------------------------
037
038   /** Default parser, all default settings.*/
039   public static final CsvParser DEFAULT = new CsvParser(PropertyStore.DEFAULT);
040
041
042   //-------------------------------------------------------------------------------------------------------------------
043   // Instance
044   //-------------------------------------------------------------------------------------------------------------------
045
046   private final Map<ClassMeta<?>,CsvClassMeta> csvClassMetas = new ConcurrentHashMap<>();
047   private final Map<BeanPropertyMeta,CsvBeanPropertyMeta> csvBeanPropertyMetas = new ConcurrentHashMap<>();
048
049   /**
050    * Constructor.
051    *
052    * @param ps The property store containing all the settings for this object.
053    */
054   public CsvParser(PropertyStore ps) {
055      super(ps, "text/csv");
056   }
057
058   @Override /* Context */
059   public CsvParserBuilder builder() {
060      return new CsvParserBuilder(getPropertyStore());
061   }
062
063   /**
064    * Instantiates a new clean-slate {@link CsvParserBuilder} object.
065    *
066    * <p>
067    * Note that this method creates a builder initialized to all default settings, whereas {@link #builder()} copies
068    * the settings of the object called on.
069    *
070    * @return A new {@link CsvParserBuilder} object.
071    */
072   public static CsvParserBuilder create() {
073      return new CsvParserBuilder();
074   }
075
076   @Override /* Parser */
077   public CsvParserSession createSession() {
078      return createSession(createDefaultSessionArgs());
079   }
080
081   @Override /* Parser */
082   public CsvParserSession createSession(ParserSessionArgs args) {
083      return new CsvParserSession(this, args);
084   }
085
086   //-----------------------------------------------------------------------------------------------------------------
087   // Extended metadata
088   //-----------------------------------------------------------------------------------------------------------------
089
090   @Override /* CsvMetaProvider */
091   public CsvClassMeta getCsvClassMeta(ClassMeta<?> cm) {
092      CsvClassMeta m = csvClassMetas.get(cm);
093      if (m == null) {
094         m = new CsvClassMeta(cm, this);
095         csvClassMetas.put(cm, m);
096      }
097      return m;
098   }
099
100   @Override /* CsvMetaProvider */
101   public CsvBeanPropertyMeta getCsvBeanPropertyMeta(BeanPropertyMeta bpm) {
102      if (bpm == null)
103         return CsvBeanPropertyMeta.DEFAULT;
104      CsvBeanPropertyMeta m = csvBeanPropertyMetas.get(bpm);
105      if (m == null) {
106         m = new CsvBeanPropertyMeta(bpm.getDelegateFor(), this);
107         csvBeanPropertyMetas.put(bpm, m);
108      }
109      return m;
110   }
111
112   //-----------------------------------------------------------------------------------------------------------------
113   // Other methods
114   //-----------------------------------------------------------------------------------------------------------------
115
116   @Override /* Context */
117   public ObjectMap toMap() {
118      return super.toMap()
119         .append("CsvParser", new DefaultFilteringObjectMap());
120   }
121}