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