metron-platform/metron-common/src/main/java/org/apache/metron/common/field/FieldNameConverter.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.metron.common.field;

/**
 * Allows field names to be transformed before a message is written to an endpoint.
 */
public interface FieldNameConverter {

  /**
   * Convert the field name.
   *
   * @param originalField The original field name.
   * @return The new field name.
   */
  String convert(String originalField);
}