MaxVertexTime.java

/*
 * Copyright © 2014 - 2021 Leipzig University (Database Research Group)
 *
 * 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
 *
 *     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.gradoop.temporal.model.impl.operators.aggregation.functions;

import org.gradoop.flink.model.api.functions.VertexAggregateFunction;
import org.gradoop.temporal.model.api.TimeDimension;

/**
 * Aggregates the maximum value of a time value for temporal vertices.
 * The value will be calculated as the maximum of a {@link TimeDimension.Field} of a
 * {@link TimeDimension}, ignoring the default value (in this case {@link Long#MAX_VALUE}).
 */
public class MaxVertexTime extends MaxTime implements VertexAggregateFunction {

  /**
   * Creates an instance of the {@link MaxVertexTime} aggregate function.
   *
   * @param dimension            The time dimension to consider.
   * @param field                The field of the time-interval to consider.
   */
  public MaxVertexTime(TimeDimension dimension, TimeDimension.Field field) {
    super(dimension, field);
  }

  /**
   * Creates an instance of the {@link MaxVertexTime} aggregate function.
   *
   * @param dimension            The time dimension to consider.
   * @param field                The field of the time-interval to consider.
   * @param aggregatePropertyKey The key of the property where the aggregated result is saved.
   */
  public MaxVertexTime(TimeDimension dimension, TimeDimension.Field field, String aggregatePropertyKey) {
    super(dimension, field, aggregatePropertyKey);
  }
}