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.serializer.*;
021
022/**
023 * TODO - Work in progress.  CSV serializer.
024 */
025@ConfigurableContext
026public final class CsvSerializer extends WriterSerializer implements CsvMetaProvider,CsvCommon {
027
028   //-------------------------------------------------------------------------------------------------------------------
029   // Configurable properties
030   //-------------------------------------------------------------------------------------------------------------------
031
032   static final String PREFIX = "CsvSerializer";
033
034   //-------------------------------------------------------------------------------------------------------------------
035   // Predefined instances
036   //-------------------------------------------------------------------------------------------------------------------
037
038   /** Default serializer, all default settings.*/
039   public static final CsvSerializer DEFAULT = new CsvSerializer(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 CsvSerializer(PropertyStore ps) {
055      super(ps, "text/csv", null);
056   }
057
058   @Override /* Context */
059   public CsvSerializerBuilder builder() {
060      return new CsvSerializerBuilder(getPropertyStore());
061   }
062
063   /**
064    * Instantiates a new clean-slate {@link CsvSerializerBuilder} object.
065    *
066    * <p>
067    * This is equivalent to simply calling <code><jk>new</jk> CsvSerializerBuilder()</code>.
068    *
069    * <p>
070    * Note that this method creates a builder initialized to all default settings, whereas {@link #builder()} copies
071    * the settings of the object called on.
072    *
073    * @return A new {@link CsvSerializerBuilder} object.
074    */
075   public static CsvSerializerBuilder create() {
076      return new CsvSerializerBuilder();
077   }
078
079   @Override /* Context */
080   public CsvSerializerSession createSession() {
081      return createSession(createDefaultSessionArgs());
082   }
083
084   @Override /* Serializer */
085   public CsvSerializerSession createSession(SerializerSessionArgs args) {
086      return new CsvSerializerSession(this, args);
087   }
088
089   //-----------------------------------------------------------------------------------------------------------------
090   // Extended metadata
091   //-----------------------------------------------------------------------------------------------------------------
092
093   @Override /* CsvMetaProvider */
094   public CsvClassMeta getCsvClassMeta(ClassMeta<?> cm) {
095      CsvClassMeta m = csvClassMetas.get(cm);
096      if (m == null) {
097         m = new CsvClassMeta(cm, this);
098         csvClassMetas.put(cm, m);
099      }
100      return m;
101   }
102
103   @Override /* CsvMetaProvider */
104   public CsvBeanPropertyMeta getCsvBeanPropertyMeta(BeanPropertyMeta bpm) {
105      if (bpm == null)
106         return CsvBeanPropertyMeta.DEFAULT;
107      CsvBeanPropertyMeta m = csvBeanPropertyMetas.get(bpm);
108      if (m == null) {
109         m = new CsvBeanPropertyMeta(bpm.getDelegateFor(), this);
110         csvBeanPropertyMetas.put(bpm, m);
111      }
112      return m;
113   }
114
115   //-----------------------------------------------------------------------------------------------------------------
116   // Other methods
117   //-----------------------------------------------------------------------------------------------------------------
118
119   @Override /* Context */
120   public ObjectMap toMap() {
121      return super.toMap()
122         .append("CsvSerializer", new DefaultFilteringObjectMap());
123   }
124}