org.infrastructurebuilder.data.IBDataSetIdentifier 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 org.infrastructurebuilder.util.IBUtils.nullSafeDateComparator;
import static org.infrastructurebuilder.util.IBUtils.nullSafeUUIDComparator;

import java.util.Comparator;
import java.util.Date;
import java.util.Optional;
import java.util.UUID;

import org.infrastructurebuilder.util.artifacts.GAV;
import org.infrastructurebuilder.util.artifacts.impl.DefaultGAV;
/**
 * This is the top-level interface that describes a DataSet.
 *
 * A DataSet is a group of common metadata that holds a set of DataStreams
 *
 * Under nearly every circumstance, one might think of a DataSet as an archive (a jar or zip file),
 * since in version 1.0.0 of the model, an archive has only a single DataSet metadata file
 * @author mykel.alvis
 *
 */
public interface IBDataSetIdentifier {

  //
  // Comparator Work
  //
  public final static Comparator IBDataSetIdentifierComparator = Comparator
      //  Check UUID
      .comparing(IBDataSetIdentifier::getId,nullSafeUUIDComparator)
      // Check Date
      .thenComparing(IBDataSetIdentifier::getCreationDate,nullSafeDateComparator);


  String getGroupId();
  String getArtifactId();
  String getVersion();

  default GAV getGAV() {
    return new DefaultGAV(getGroupId(), getArtifactId(), getVersion());
  }

  UUID getId();

  Optional getName();

  Optional getDescription();

  Date getCreationDate();

  Object getMetadata();  // The actually working type is either Document or Xpp3Dom, depending on source

  /**
   * Possibly null representation of where this dataset currently exists.
   * This value should be nulled out prior to persisting the model, and must
   * be set when deserializing it.
   *
   * @return
   */
  String getPath();


}