org.infrastructurebuilder.data.IBDataStructuredDataFieldMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibdata-api Show documentation
APIs for dealing with data streams
The newest version!
/**
 * Copyright © 2019 admin ([email protected])
 *
 * 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.infrastructurebuilder.data;

import static java.util.Collections.emptyList;
import static java.util.Optional.empty;
import static java.util.Optional.ofNullable;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.List;
import java.util.Optional;

/**
 * This type's name is a mouthful.
 *
 * This type describes an optional piece of metadata about a field in a
 * DataStream that contains structured (or somewhat structured) data. These values are meant to be
 * calculated at transformation time, so the transformation should produce them.
 * They could change during the course of a transformation so it's important
 * that we be able to manipulate the list easily.
 *
 * @author mykel.alvis
 *
 */
public interface IBDataStructuredDataFieldMetadata {

  /**
   * Required. 0-based index of this field
   *
   * @return
   */
  int getIndex();

  /**
   * If we have a name, return it
   *
   * @return
   */
  default Optional getFieldName() {
    return empty();
  }

  /**
   * Returns the string representations of enumeration values (the "name()"s).
   *
   * @return
   */
  List getEnumerations();

  default boolean isEnumeration() {
    return ofNullable(getEnumerations()).orElse(emptyList()).size() > 0;
  }

  default Optional getMaxIntValue() {
    try {
      return ofNullable(getMax()).map(BigInteger::new);
    } catch (NumberFormatException e) {
      return empty();
    }
  }

  default Optional getMinIntValue() {
    try {

      return ofNullable(getMin()).map(BigInteger::new);
    } catch (NumberFormatException e) {
      return empty();
    }
  }

  default Optional getMaxRealValue() {
    try {
      return ofNullable(getMax()).map(BigDecimal::new);
    } catch (NumberFormatException e) {
      return empty();
    }
  }

  default Optional getMinRealValue() {
    try {
      return ofNullable(getMin()).map(BigDecimal::new);
    } catch (NumberFormatException e) {
      return empty();
    }
  }


  default Optional getUniqueValuesCount() {
    return empty();
  }

  /**
   * Is this field nullable
   *
   * @return returns empty if unknown, or Optional if nullable
   */
  default Optional isNullable() {
    return Optional.ofNullable(getNullable()).map(f -> "true".equalsIgnoreCase(f));
  }

  default Optional getType() {
    return ofNullable(getMetadataType()).map(IBDataStructuredDataMetadataType::valueOf);
  }

  /**
   * Allows us to the the string type in the model from the enum
   *
   * @param t
   */
  void setType(IBDataStructuredDataMetadataType t);

  /*
   * The following are implemented in the generated model directly. They are
   * stored as strings because their types are needed within this interface but
   * cannot be relied on to have good typing.  These may/should return null if not set
   */
  String getMin();

  String getMax();

  String getNullable();

  String getMetadataType();

}