com.hcl.domino.richtext.structures.AssistFieldStruct Maven / Gradle / Ivy
/*
* ==========================================================================
* Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
* All rights reserved.
* ==========================================================================
* Licensed 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 .
*
* 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 com.hcl.domino.richtext.structures;
import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import com.hcl.domino.data.NativeItemCoder;
import com.hcl.domino.misc.INumberEnum;
import com.hcl.domino.misc.StructureSupport;
import com.hcl.domino.richtext.annotation.StructureDefinition;
import com.hcl.domino.richtext.annotation.StructureGetter;
import com.hcl.domino.richtext.annotation.StructureMember;
import com.hcl.domino.richtext.annotation.StructureSetter;
import com.hcl.domino.richtext.records.RecordType;
/**
* @author Jesse Gallagher
* @since 1.0.15
*/
@StructureDefinition(
name = "ODS_ASSISTFIELDSTRUCT",
members = {
@StructureMember(name = "wTotalLen", type = short.class, unsigned = true),
@StructureMember(name = "wOperator", type = short.class),
@StructureMember(name = "wFieldNameLen", type = short.class, unsigned = true),
@StructureMember(name = "wValueLen", type = short.class, unsigned = true),
@StructureMember(name = "wValueDataType", type = short.class),
@StructureMember(name = "wSpare", type = short.class)
}
)
public interface AssistFieldStruct extends ResizableMemoryStructure {
enum ActionByField implements INumberEnum {
REPLACE(1),
APPEND(2),
REMOVE(3);
private final short value;
ActionByField(final int value) {
this.value = (short) value;
}
@Override
public long getLongValue() {
return this.value;
}
@Override
public Short getValue() {
return this.value;
}
}
enum QueryByField implements INumberEnum {
GREATER(1), /* Greater than value */
LESS(2), /* Less than value */
NOTEQUAL(3), /* Not equal to value */
BETWEEN(4), /* Between Date1 and Date2 */
NOTWITHIN(5), /* Not between Date1 and Date2 */
EQUAL(6), /* Equal to value */
CONTAINS(7), /* Contains value */
INTHELAST(8), /* In the last n days */
INTHENEXT(9), /* In the next n days */
OLDERTHAN(10), /* Older than n days */
DUEIN(11), /* Due more than n days from now */
DOESNOTCONTAIN(12); /* Does not contain */
private final short value;
QueryByField(final int value) {
this.value = (short) value;
}
@Override
public long getLongValue() {
return this.value;
}
@Override
public Short getValue() {
return this.value;
}
}
@StructureGetter("wOperator")
Optional getActionOperator();
/**
* Retrieves the action operator as a raw {@code short}.
*
* @return the action operator as a {@code short}
* @since 1.24.0
*/
@StructureGetter("wOperator")
short getActionOperatorRaw();
default String getFieldName() {
return StructureSupport.extractStringValue(
this,
0,
this.getFieldNameLength()
);
}
@StructureGetter("wFieldNameLen")
int getFieldNameLength();
@StructureGetter("wOperator")
short getOperatorRaw();
@StructureGetter("wOperator")
Optional getQueryOperator();
/**
* Gets the query operator as a raw {@code short}.
*
* @return the query operator as a {@code short}
* @since 1.24.0
*/
@StructureGetter("wOperator")
short getQueryOperatorRaw();
@StructureGetter("wTotalLen")
int getTotalLength();
default byte[] getValueData() {
final ByteBuffer buf = this.getVariableData();
final int nameLen = this.getFieldNameLength();
final int valueLen = this.getValueLength();
buf.position(buf.position() + nameLen);
final byte[] valueData = new byte[valueLen];
buf.get(valueData);
return valueData;
}
@StructureGetter("wValueDataType")
short getValueDataType();
@StructureGetter("wValueLen")
int getValueLength();
/**
* Retrieves the item values represented in this structure.
*
* @param the expected data type based on {@link #getValueDataType()}
* @return a {@link List} of decoded item values
*/
@SuppressWarnings("unchecked")
default List getValues() {
final ByteBuffer buf = this.getVariableData();
final int nameLen = this.getFieldNameLength();
buf.position(buf.position() + nameLen);
byte[] val = new byte[buf.remaining()];
buf.get(val);
return (List)(List)NativeItemCoder.get().decodeItemValue(val, RecordType.Area.TYPE_COMPOSITE);
}
@StructureSetter("wOperator")
AssistFieldStruct setActionOperator(ActionByField actionByField);
/**
* Sets the action operator as a raw {@code short}.
*
* @param actionByField the value to set
* @return this structure
* @since 1.24.0
*/
@StructureSetter("wOperator")
AssistFieldStruct setActionOperatorRaw(short actionByField);
default AssistFieldStruct setFieldName(final String name) {
StructureSupport.writeStringValue(
this,
0,
this.getFieldNameLength(),
name,
(int len) -> {
this.setFieldNameLength(len);
}
);
this.setTotalLength(this.getData().remaining());
return this;
}
@StructureSetter("wFieldNameLen")
AssistFieldStruct setFieldNameLength(int fieldNameLength);
@StructureSetter("wOperator")
AssistFieldStruct setOperatorRaw(short operator);
@StructureSetter("wOperator")
AssistFieldStruct setQueryOperator(QueryByField queryByField);
/**
* Sets the query operator as a raw {@code short}.
*
* @param queryByField the value to set
* @return this structure
* @since 1.24.0
*/
@StructureSetter("wOperator")
AssistFieldStruct setQueryOperatorRaw(short queryByField);
@StructureSetter("wTotalLen")
AssistFieldStruct setTotalLength(int totalLength);
@StructureSetter("wValueDataType")
AssistFieldStruct setValueDataType(short valueDataType);
@StructureSetter("wValueLen")
AssistFieldStruct setValueLength(int valueLength);
default AssistFieldStruct setValues(final Collection values) {
final Collection vals = values == null ? Collections.emptyList() : values;
int valueLen = 2 // WORD: TYPE_TEXT_LIST
+ 2 // USHORT ListEntries
+ 2 * vals.size(); // USHORT string lengs
final Charset lmbcsCharset = NativeItemCoder.get().getLmbcsCharset();
final List lmbcs = new ArrayList<>(vals.size());
for (final String val : vals) {
final byte[] valBytes = val.getBytes(lmbcsCharset);
if (valBytes.length > 0xFFFF) {
throw new IllegalArgumentException(MessageFormat.format("Unable to store LMBCS value of length {0}", valBytes.length));
}
lmbcs.add(valBytes);
}
valueLen += lmbcs.stream().mapToInt(b -> b.length).sum();
final int nameLen = this.getFieldNameLength();
int variableLen = nameLen + valueLen;
variableLen += variableLen % 2;
if (variableLen + 12 > 0xFFFF) {
throw new IllegalArgumentException("Unable to store total value exceeding 0xFFFF bytes");
}
this.resizeVariableData(variableLen);
final ByteBuffer buf = this.getVariableData();
buf.position(buf.position() + nameLen);
buf.putShort((short) (1 + (5 << 8)));
buf.putShort((short) vals.size());
for (final byte[] val : lmbcs) {
buf.putShort((short) val.length);
}
for (final byte[] val : lmbcs) {
buf.put(val);
}
this.setTotalLength(this.getData().remaining());
this.setValueLength(valueLen);
return this;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy