solr/contrib/analytics/src/java/org/apache/solr/analytics/value/constant/ConstantStringValue.java

/*
 * 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.solr.analytics.value.constant;

import java.util.function.Consumer;

import org.apache.solr.analytics.facet.compare.ConstantComparator;
import org.apache.solr.analytics.value.StringValue;
import org.apache.solr.analytics.value.StringValue.CastingStringValue;

/**
 * A constant {@link StringValue}. Every call to {@link #getString()} and other methods will return the same constant value.
 */
public class ConstantStringValue extends ConstantValue implements CastingStringValue {
  String value;
  public static final String name = "const_str";
  private final String exprStr;

  public ConstantStringValue(String value) {
    this.value = value;
    this.exprStr = ConstantValue.createExpressionString(this, value);
  }

  @Override
  public String getString() {
    return value;
  }
  @Override
  public Object getObject() {
    return value;
  }
  @Override
  public boolean exists() {
    return true;
  }

  @Override
  public void streamStrings(Consumer<String> cons) {
    cons.accept(value);
  }
  @Override
  public void streamObjects(Consumer<Object> cons) {
    cons.accept(value);
  }

  @Override
  public ConstantComparator getObjectComparator(String expression) {
    return new ConstantComparator();
  }

  @Override
  public String getName() {
    return name;
  }

  @Override
  public String getExpressionStr() {
    return exprStr;
  }

  @Override
  public ExpressionType getExpressionType() {
    return ExpressionType.CONST;
  }
}