Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.documentmodel;
import com.yahoo.document.DataType;
import com.yahoo.document.Field;
import com.yahoo.vespa.objects.FieldBase;
import java.io.Serializable;
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.stream.Collectors;
import static com.yahoo.text.Lowercase.toLowerCase;
/**
* A summary field
*
* @author bratseth
*/
public class SummaryField extends FieldBase implements Cloneable {
/** A source (field name). */
public static class Source implements Serializable {
private final String name;
private boolean override = false;
public Source(String name) {
this.name = name;
}
public String getName() { return name; }
public void setOverride(boolean override) { this.override = override; }
public boolean getOverride() { return override; }
@Override
public int hashCode() {
return name.hashCode() + Boolean.valueOf(override).hashCode();
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof Source other)) return false;
return name.equals(other.name) && override == other.override;
}
@Override
public String toString() {
return "source field '" + name + "'";
}
}
/** The transform to perform on the stored source */
private SummaryTransform transform;
/** The command used per field in vsmsummary */
private VsmCommand vsmCommand = VsmCommand.NONE;
private DataType dataType;
/**
* The data sources for this output summary field, in prioritized order
* (use only second source if first yields no result after transformation
* and so on). If no sources are given explicitly, the field of the same
* name as this summary field is used
*/
private Set sources = new java.util.LinkedHashSet<>();
private Set destinations = new java.util.LinkedHashSet<>();
/** True if this field was defined implicitly */
private boolean implicit = false;
private boolean unresolvedType = false;
/** Creates a summary field with NONE as transform */
public SummaryField(String name, DataType type) {
this(name, type, SummaryTransform.NONE);
}
/** Creates a summary field with NONE as transform */
public SummaryField(Field field) {
this(field, SummaryTransform.NONE);
}
public SummaryField(Field field, SummaryTransform transform) {
this(field.getName(), field.getDataType(), transform);
}
public SummaryField(String name, DataType type, SummaryTransform transform) {
super(name);
this.transform=transform;
this.dataType = type;
}
public static SummaryField createWithUnresolvedType(String name) {
/*
* Data type is not available during conversion of
* parsed schema to schema. Use a placeholder data type and tag the summary
* field as having an unresolved type.
*/
var summaryField = new SummaryField(name, DataType.NONE);
summaryField.unresolvedType = true;
return summaryField;
}
public void setImplicit(boolean implicit) { this.implicit=implicit; }
public boolean isImplicit() { return implicit; }
public boolean hasUnresolvedType() { return unresolvedType; }
public DataType getDataType() {
return dataType;
}
public void setTransform(SummaryTransform transform) {
this.transform = transform;
if (SummaryTransform.DYNAMICTEASER.equals(transform) || SummaryTransform.BOLDED.equals(transform)) {
// This is the kind of logic we want to have in processing,
// but can't because of deriveDocuments mode, which doesn't run
// processing.
setVsmCommand(VsmCommand.FLATTENJUNIPER);
}
}
public SummaryTransform getTransform() { return transform; }
/** Returns the first source field of this, or null if the source field is not present */
public String getSourceField() {
String sourceName = getName();
if ( ! sources.isEmpty())
sourceName = sources.iterator().next().getName();
return sourceName;
}
public void addSource(String name) {
sources.add(new Source(name));
}
public void addSource(Source source) {
sources.add(source);
}
public Iterator sourceIterator() {
return sources.iterator();
}
public int getSourceCount() {
return sources.size();
}
/** Returns a modifiable set of the sources of this */
public Set getSources() { return sources; }
/** Returns the first source name of this, or the field name if no source has been set */
public String getSingleSource() {
if (sources.isEmpty()) return getName();
return sources.iterator().next().getName();
}
public void addDestination(String name) {
destinations.add(name);
}
public final void addDestinations(Iterable names) {
for (String name : names) {
addDestination(name);
}
}
/** Returns an modifiable view of the destination set owned by this */
public Set getDestinations() {
return destinations;
}
public String toString(Collection collection) {
StringBuilder buffer=new StringBuilder();
for (Iterator i=collection.iterator(); i.hasNext(); ) {
buffer.append(i.next().toString());
if (i.hasNext())
buffer.append(", ");
}
return buffer.toString();
}
/**
* Returns a summary field which merges the settings in the given field
* into this field
*
* @param merge the field to merge with this, if null, the merged field is *this* field
* @throws RuntimeException if the two fields can not be merged
*/
public SummaryField mergeWith(SummaryField merge) {
if (merge == null) return this;
if (this.isImplicit()) return merge;
if (merge.isImplicit()) return this;
if (!merge.getName().equals(getName()))
throw new IllegalArgumentException(merge + " conflicts with " + this + ": different names");
if (merge.getTransform() != getTransform())
throw new IllegalArgumentException(merge + " conflicts with " + this + ": different transforms");
if (!merge.dataType.equals(dataType))
throw new IllegalArgumentException(merge + " conflicts with " + this + ": different types");
setImplicit(false);
if (isHeadOf(this.sourceIterator(), merge.sourceIterator())) {
// Ok
}
else if (isHeadOf(merge.sourceIterator(), this.sourceIterator())) {
sources = new LinkedHashSet<>(merge.sources);
}
else {
throw new IllegalArgumentException(merge + " conflicts with " + this +
": on source list must be the start of the other");
}
destinations.addAll(merge.destinations);
return this;
}
public boolean hasSource(String name) {
if (sources.isEmpty() && name.equals(getName())) {
return true;
}
for (Source s : sources) {
if (s.getName().equals(name)) {
return true;
}
}
return false;
}
/**
* Returns true if the second list is the start of the first list
*/
private boolean isHeadOf(Iterator full, Iterator head) {
while (head.hasNext()) {
if (!full.hasNext()) return false;
if (!full.next().equals(head.next())) return false;
}
return true;
}
private String getDestinationString() {
return destinations.stream().map(destination -> "document-summary '" + destination + "'").collect(Collectors.joining(", "));
}
@Override
public String toString() {
return "summary field '" + getName() + "'";
}
/** Returns a string which aids locating this field in the source search definition */
public String toLocateString() {
return "summary " + getName() + " type " + toLowerCase(dataType.getName()) + " in " + getDestinationString();
}
@Override
public SummaryField clone() {
try {
SummaryField clone = (SummaryField)super.clone();
if (this.sources != null)
clone.sources = new LinkedHashSet<>(this.sources);
if (this.destinations != null)
clone.destinations = new LinkedHashSet<>(destinations);
clone.unresolvedType = unresolvedType;
return clone;
}
catch (CloneNotSupportedException e) {
throw new RuntimeException("Programming error");
}
}
/**
* Returns true if the summary field uses an explicit source, i.e.
* a field with different name that is not a nested field.
*/
public boolean hasExplicitSingleSource() {
String fieldName = getName();
String sourceName = getSingleSource();
if (fieldName.equals(sourceName)) {
return false;
}
if (sourceName.contains(".")) {
return false;
}
if (sources.size() > 1) {
return false;
}
return true;
}
public void setResolvedDataType(DataType type) {
this.dataType = type;
unresolvedType = false;
}
public VsmCommand getVsmCommand() {
return vsmCommand;
}
public void setVsmCommand(VsmCommand vsmCommand) {
this.vsmCommand = vsmCommand;
}
/**
* The command used when using data from this SummaryField to generate StreamingSummary config (vsmsummary).
* Not used for ordinary Summary config.
*
* @author vegardh
*
*/
public enum VsmCommand {
NONE("NONE"),
FLATTENSPACE("FLATTENSPACE"),
FLATTENJUNIPER("FLATTENJUNIPER");
private final String cmd;
VsmCommand(String cmd) {
this.cmd=cmd;
}
@Override
public String toString() {
return cmd;
}
}
}
