org.apache.arrow.vector.IntervalYearVector Maven / Gradle / Ivy
Show all versions of arrow-vector Show documentation
/*
* 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.
*/
package org.apache.arrow.vector;
import static org.apache.arrow.vector.NullCheckingForGet.NULL_CHECKING_ENABLED;
import java.time.Period;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.vector.complex.impl.IntervalYearReaderImpl;
import org.apache.arrow.vector.complex.reader.FieldReader;
import org.apache.arrow.vector.holders.IntervalYearHolder;
import org.apache.arrow.vector.holders.NullableIntervalYearHolder;
import org.apache.arrow.vector.types.Types.MinorType;
import org.apache.arrow.vector.types.pojo.Field;
import org.apache.arrow.vector.types.pojo.FieldType;
import org.apache.arrow.vector.util.TransferPair;
import io.netty.buffer.ArrowBuf;
/**
* IntervalYearVector implements a fixed width (4 bytes) vector of
* interval (years and months) values which could be null. A validity buffer
* (bit vector) is maintained to track which elements in the vector are null.
*/
public final class IntervalYearVector extends BaseFixedWidthVector {
private static final byte TYPE_WIDTH = 4;
private final FieldReader reader;
/**
* Instantiate a IntervalYearVector. This doesn't allocate any memory for
* the data in vector.
*
* @param name name of the vector
* @param allocator allocator for memory management.
*/
public IntervalYearVector(String name, BufferAllocator allocator) {
this(name, FieldType.nullable(MinorType.INTERVALYEAR.getType()), allocator);
}
/**
* Instantiate a IntervalYearVector. This doesn't allocate any memory for
* the data in vector.
*
* @param name name of the vector
* @param fieldType type of Field materialized by this vector
* @param allocator allocator for memory management.
*/
public IntervalYearVector(String name, FieldType fieldType, BufferAllocator allocator) {
this(new Field(name, fieldType, null), allocator);
}
/**
* Instantiate a IntervalYearVector. This doesn't allocate any memory for
* the data in vector.
*
* @param field field materialized by this vector
* @param allocator allocator for memory management.
*/
public IntervalYearVector(Field field, BufferAllocator allocator) {
super(field, allocator, TYPE_WIDTH);
reader = new IntervalYearReaderImpl(IntervalYearVector.this);
}
/**
* Get a reader that supports reading values from this vector.
*
* @return Field Reader for this vector
*/
@Override
public FieldReader getReader() {
return reader;
}
/**
* Get minor type for this vector. The vector holds values belonging
* to a particular type.
*
* @return {@link org.apache.arrow.vector.types.Types.MinorType}
*/
@Override
public MinorType getMinorType() {
return MinorType.INTERVALYEAR;
}
/*----------------------------------------------------------------*
| |
| vector value retrieval methods |
| |
*----------------------------------------------------------------*/
/**
* Given a data buffer, get the value stored at a particular position
* in the vector.
*
* This method should not be used externally.
*
* @param buffer data buffer
* @param index position of the element.
* @return value stored at the index.
*/
public static int getTotalMonths(final ArrowBuf buffer, final int index) {
return buffer.getInt(index * TYPE_WIDTH);
}
/**
* Get the element at the given index from the vector.
*
* @param index position of element
* @return element at given index
*/
public int get(int index) throws IllegalStateException {
if (NULL_CHECKING_ENABLED && isSet(index) == 0) {
throw new IllegalStateException("Value at index is null");
}
return valueBuffer.getInt(index * TYPE_WIDTH);
}
/**
* Get the element at the given index from the vector and
* sets the state in holder. If element at given index
* is null, holder.isSet will be zero.
*
* @param index position of element
*/
public void get(int index, NullableIntervalYearHolder holder) {
if (isSet(index) == 0) {
holder.isSet = 0;
return;
}
holder.isSet = 1;
holder.value = valueBuffer.getInt(index * TYPE_WIDTH);
}
/**
* Same as {@link #get(int)}.
*
* @param index position of element
* @return element at given index
*/
public Period getObject(int index) {
if (isSet(index) == 0) {
return null;
} else {
final int interval = valueBuffer.getInt(index * TYPE_WIDTH);
// TODO: verify interval is in months
return Period.ofMonths(interval);
}
}
/**
* Get the Interval value at a given index as a {@link StringBuilder} object.
*
* @param index position of the element
* @return String Builder object with Interval value as
* [years, months]
*/
public StringBuilder getAsStringBuilder(int index) {
if (isSet(index) == 0) {
return null;
} else {
return getAsStringBuilderHelper(index);
}
}
private StringBuilder getAsStringBuilderHelper(int index) {
int value = valueBuffer.getInt(index * TYPE_WIDTH);
final int years = (value / org.apache.arrow.vector.util.DateUtility.yearsToMonths);
final int months = (value % org.apache.arrow.vector.util.DateUtility.yearsToMonths);
final String yearString = (Math.abs(years) == 1) ? " year " : " years ";
final String monthString = (Math.abs(months) == 1) ? " month " : " months ";
return (new StringBuilder()
.append(years)
.append(yearString)
.append(months)
.append(monthString));
}
/*----------------------------------------------------------------*
| |
| vector value setter methods |
| |
*----------------------------------------------------------------*/
private void setValue(int index, int value) {
valueBuffer.setInt(index * TYPE_WIDTH, value);
}
/**
* Set the element at the given index to the given value.
*
* @param index position of element
* @param value value of element
*/
public void set(int index, int value) {
BitVectorHelper.setBit(validityBuffer, index);
setValue(index, value);
}
/**
* Set the element at the given index to the value set in data holder.
* If the value in holder is not indicated as set, element in the
* at the given index will be null.
*
* @param index position of element
* @param holder nullable data holder for value of element
*/
public void set(int index, NullableIntervalYearHolder holder) throws IllegalArgumentException {
if (holder.isSet < 0) {
throw new IllegalArgumentException();
} else if (holder.isSet > 0) {
BitVectorHelper.setBit(validityBuffer, index);
setValue(index, holder.value);
} else {
BitVectorHelper.unsetBit(validityBuffer, index);
}
}
/**
* Set the element at the given index to the value set in data holder.
*
* @param index position of element
* @param holder data holder for value of element
*/
public void set(int index, IntervalYearHolder holder) {
BitVectorHelper.setBit(validityBuffer, index);
setValue(index, holder.value);
}
/**
* Same as {@link #set(int, int)} except that it handles the
* case when index is greater than or equal to existing
* value capacity {@link #getValueCapacity()}.
*
* @param index position of element
* @param value value of element
*/
public void setSafe(int index, int value) {
handleSafe(index);
set(index, value);
}
/**
* Same as {@link #set(int, NullableIntervalYearHolder)} except that it handles the
* case when index is greater than or equal to existing
* value capacity {@link #getValueCapacity()}.
*
* @param index position of element
* @param holder nullable data holder for value of element
*/
public void setSafe(int index, NullableIntervalYearHolder holder) throws IllegalArgumentException {
handleSafe(index);
set(index, holder);
}
/**
* Same as {@link #set(int, IntervalYearHolder)} except that it handles the
* case when index is greater than or equal to existing
* value capacity {@link #getValueCapacity()}.
*
* @param index position of element
* @param holder data holder for value of element
*/
public void setSafe(int index, IntervalYearHolder holder) {
handleSafe(index);
set(index, holder);
}
/**
* Store the given value at a particular position in the vector. isSet indicates
* whether the value is NULL or not.
*
* @param index position of the new value
* @param isSet 0 for NULL value, 1 otherwise
* @param value element value
*/
public void set(int index, int isSet, int value) {
if (isSet > 0) {
set(index, value);
} else {
BitVectorHelper.unsetBit(validityBuffer, index);
}
}
/**
* Same as {@link #set(int, int, int)} except that it handles the case
* when index is greater than or equal to current value capacity of the
* vector.
*
* @param index position of the new value
* @param isSet 0 for NULL value, 1 otherwise
* @param value element value
*/
public void setSafe(int index, int isSet, int value) {
handleSafe(index);
set(index, isSet, value);
}
/*----------------------------------------------------------------*
| |
| vector transfer |
| |
*----------------------------------------------------------------*/
/**
* Construct a TransferPair comprising of this and a target vector of
* the same type.
*
* @param ref name of the target vector
* @param allocator allocator for the target vector
* @return {@link TransferPair}
*/
@Override
public TransferPair getTransferPair(String ref, BufferAllocator allocator) {
return new TransferImpl(ref, allocator);
}
/**
* Construct a TransferPair with a desired target vector of the same type.
*
* @param to target vector
* @return {@link TransferPair}
*/
@Override
public TransferPair makeTransferPair(ValueVector to) {
return new TransferImpl((IntervalYearVector) to);
}
private class TransferImpl implements TransferPair {
IntervalYearVector to;
public TransferImpl(String ref, BufferAllocator allocator) {
to = new IntervalYearVector(ref, field.getFieldType(), allocator);
}
public TransferImpl(IntervalYearVector to) {
this.to = to;
}
@Override
public IntervalYearVector getTo() {
return to;
}
@Override
public void transfer() {
transferTo(to);
}
@Override
public void splitAndTransfer(int startIndex, int length) {
splitAndTransferTo(startIndex, length, to);
}
@Override
public void copyValueSafe(int fromIndex, int toIndex) {
to.copyFromSafe(fromIndex, toIndex, IntervalYearVector.this);
}
}
}