gov.nasa.pds.tools.inventory.reader.InventoryEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of validate Show documentation

The Validate Tool project contains software for validating PDS4 product labels and product data.

There is a newer version: 3.6.2

// Copyright 2006-2017, by the California Institute of Technology.
// ALL RIGHTS RESERVED. United States Government Sponsorship acknowledged.
// Any commercial use must be negotiated with the Office of Technology Transfer
// at the California Institute of Technology.
//
// This software is subject to U. S. export control laws and regulations
// (22 C.F.R. 120-130 and 15 C.F.R. 730-774). To the extent that the software
// is subject to U.S. export control laws and regulations, the recipient has
// the responsibility to obtain export licenses or other export authority as
// may be required before exporting such information to foreign countries or
// providing access to foreign nationals.
//
// $Id: InventoryEntry.java 8162 2010-11-10 22:05:09Z mcayanan $
package gov.nasa.pds.tools.inventory.reader;

import java.io.File;

/**
 * Class representation of a single entry in a PDS Inventory file.
 *
 * @author mcayanan
 *
 */
public class InventoryEntry {
  /** A product file. */
  private File file;

  /** A checksum. */
  private String checksum;

  /** A logical identifier. */
  private String identifier;

  /** Member status. */
  private String memberStatus;

  /** Default constructor */
  public InventoryEntry() {
      this.file = null;
      this.checksum = "";
      this.identifier = "";
      this.memberStatus = "";
  }

  /**
   * Constructor.
   *
   * @param identifier logical identifier.
   * @param memberStatus member status.
   */
  public InventoryEntry(String identifier, String memberStatus) {
    this(null, "", identifier, memberStatus);
  }

  /**
   * Constructor.
   *
   * @param file A product file.
   * @param checksum checksum.
   * @param identifier logical identifier.
   */
  public InventoryEntry(File file, String checksum, String identifier, String memberStatus) {
      this.file = file;
      this.checksum = checksum;
      this.identifier = identifier;
      this.memberStatus = memberStatus;
  }

  /**
   * Gets the file.
   *
   * @return The file.
   */
  public File getFile() {
      return file;
  }

  /**
   * Gets the checksum.
   *
   * @return Checksum value.
   */
  public String getChecksum() {
      return checksum;
  }

  /**
   * Gets the logical identifier.
   *
   * @return A LID or LIDVID.
   */
  public String getIdentifier() {
      return identifier;
  }

  /**
   * Gets the member status.
   *
   * @return "P", "Primary", "S", or "Secondary"
   */
  public String getMemberStatus() {
    return memberStatus;
  }

  /**
   * Determines whether the object is empty.
   *
   * @return true if the object is empty, false otherwise.
   */
  public boolean isEmpty() {
      if (this.file == null && this.checksum.isEmpty()
          && this.identifier.isEmpty() && this.memberStatus.isEmpty()) {
        return true;
      } else {
        return false;
      }
  }
}