| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| <@pp.dropOutputFile /> |
| <@pp.changeOutputFile name="/org/apache/drill/exec/vector/complex/writer/BaseWriter.java" /> |
| |
| |
| <#include "/@includes/license.ftl" /> |
| |
| package org.apache.drill.exec.vector.complex.writer; |
| |
| <#include "/@includes/vv_imports.ftl" /> |
| |
| /* |
| * File generated from ${.template_name} using FreeMarker. |
| */ |
| @SuppressWarnings("unused") |
| public interface BaseWriter extends AutoCloseable, Positionable { |
| FieldWriter getParent(); |
| int getValueCapacity(); |
| |
| public interface MapWriter extends BaseWriter { |
| |
| MaterializedField getField(); |
| |
| /** |
| * Whether this writer is a map writer and is empty (has no children). |
| * |
| * <p> |
| * Intended only for use in determining whether to add dummy vector to |
| * avoid empty (zero-column) schema, as in JsonReader. |
| * </p> |
| * |
| */ |
| boolean isEmptyMap(); |
| |
| <#list vv.types as type><#list type.minor as minor> |
| <#assign lowerName = minor.class?uncap_first /> |
| <#if lowerName == "int" ><#assign lowerName = "integer" /></#if> |
| <#assign upperName = minor.class?upper_case /> |
| <#assign capName = minor.class?cap_first /> |
| <#if minor.class?contains("Decimal") > |
| ${capName}Writer ${lowerName}(String name, int precision, int scale); |
| </#if> |
| ${capName}Writer ${lowerName}(String name); |
| </#list></#list> |
| |
| void copyReaderToField(String name, FieldReader reader); |
| MapWriter map(String name); |
| ListWriter list(String name); |
| UnionVectorWriter union(String name); |
| void start(); |
| void end(); |
| DictWriter dict(String name); |
| } |
| |
| public interface DictWriter extends MapWriter { |
| /** |
| * Prepares key and value writers to write new values. |
| * Must be invoked before writing data to these fields. |
| */ |
| void startKeyValuePair(); |
| |
| /** |
| * Finalizes writing values to key and value writers. |
| * Must be invoked after the values for the fields are written. |
| */ |
| void endKeyValuePair(); |
| FieldWriter getKeyWriter(); |
| FieldWriter getValueWriter(); |
| } |
| |
| public interface ListWriter extends BaseWriter { |
| void startList(); |
| void endList(); |
| MapWriter map(); |
| DictWriter dict(); |
| ListWriter list(); |
| UnionVectorWriter union(); |
| void copyReader(FieldReader reader); |
| |
| <#list vv.types as type><#list type.minor as minor> |
| <#assign lowerName = minor.class?uncap_first /> |
| <#if lowerName == "int" ><#assign lowerName = "integer" /></#if> |
| <#assign upperName = minor.class?upper_case /> |
| <#assign capName = minor.class?cap_first /> |
| <#if minor.class?contains("Decimal") > |
| ${capName}Writer ${lowerName}(int precision, int scale); |
| </#if> |
| ${capName}Writer ${lowerName}(); |
| </#list></#list> |
| } |
| |
| public interface ScalarWriter extends |
| <#list vv.types as type><#list type.minor as minor><#assign name = minor.class?cap_first /> ${name}Writer, </#list></#list> BaseWriter {} |
| |
| public interface ComplexWriter { |
| void allocate(); |
| void clear(); |
| void copyReader(FieldReader reader); |
| MapWriter rootAsMap(); |
| ListWriter rootAsList(); |
| |
| void setPosition(int index); |
| void setValueCount(int count); |
| void reset(); |
| } |
| |
| public interface MapOrListWriter { |
| void start(); |
| void end(); |
| MapOrListWriter map(String name); |
| MapOrListWriter listoftmap(String name); |
| MapOrListWriter dict(String name); |
| MapOrListWriter listOfDict(); |
| MapOrListWriter list(String name); |
| boolean isMapWriter(); |
| boolean isListWriter(); |
| UInt1Writer uInt1(String name); |
| UInt2Writer uInt2(String name); |
| UInt4Writer uInt4(String name); |
| UInt8Writer uInt8(String name); |
| VarCharWriter varChar(String name); |
| Var16CharWriter var16Char(String name); |
| VarDecimalWriter varDecimal(String name); |
| VarDecimalWriter varDecimal(String name, int precision, int scale); |
| TinyIntWriter tinyInt(String name); |
| SmallIntWriter smallInt(String name); |
| IntWriter integer(String name); |
| BigIntWriter bigInt(String name); |
| Float4Writer float4(String name); |
| Float8Writer float8(String name); |
| BitWriter bit(String name); |
| VarBinaryWriter varBinary(String name); |
| /** |
| * @deprecated Use {@link #varBinary(String)} instead. |
| */ |
| @Deprecated |
| VarBinaryWriter binary(String name); |
| DateWriter date(String name); |
| TimeWriter time(String name); |
| TimeStampWriter timeStamp(String name); |
| IntervalYearWriter intervalYear(String name); |
| IntervalDayWriter intervalDay(String name); |
| IntervalWriter interval(String name); |
| Decimal9Writer decimal9(String name); |
| Decimal18Writer decimal18(String name); |
| Decimal28DenseWriter decimal28Dense(String name); |
| Decimal38DenseWriter decimal38Dense(String name); |
| Decimal38SparseWriter decimal38Sparse(String name); |
| Decimal28SparseWriter decimal28Sparse(String name); |
| } |
| |
| } |