com.marklogic.client.io.Format Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marklogic-client-api Show documentation
The official MarkLogic Java client API.
The newest version!
/*
 * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
 */
package com.marklogic.client.io;

import com.marklogic.client.MarkLogicInternalException;

import java.util.regex.Pattern;

/**
 * The Format enumerates different kinds of document content.
 */
public enum Format {
  /**
   * Identifies the format of binary documents such as images.
   */
  BINARY,
  /**
   * Identifies the format of JSON documents.
   */
  JSON,
  /**
   * Identifies the format of text documents such as plain text and HTML.
   */
  TEXT,
  /**
   * Identifies the format of XML documents such as XHTML.
   */
  XML,
  /**
   * Used for documents with unknown or multiple formats.
   */
  UNKNOWN;

  static final private Pattern BINARY_MIMETYPE_PATTERN =
          Pattern.compile("^\\s*application/([^+]+\\+)?(octet-stream|x-unknown-content-type)(\\s*;.*)?$");
  static final private Pattern JSON_MIMETYPE_PATTERN =
          Pattern.compile("^\\s*(application|text)/([^+;]+\\+)?json(\\s*;.*)?$");
  static final private Pattern XML_MIMETYPE_PATTERN  =
          Pattern.compile("^\\s*(application|text)/([^+;]+\\+)?xml(\\s*;.*)?$");

  /**
   * Returns the default mime type for the format.
   * @return	the default mime type
   */
  public String getDefaultMimetype() {
    switch(this) {
      case UNKNOWN:
        return null;
      case BINARY:
        // TODO: or possibly "application/x-unknown-content-type"
        return "application/octet-stream";
      case JSON:
        return "application/json";
      case TEXT:
        return "text/plain";
      case XML:
        return "application/xml";
      default:
        throw new MarkLogicInternalException("Unknown format "+this.toString());
    }
  }

  /**
   * Returns the default extension for the format.
   * @return the default extension
   */
  public String getDefaultExtension() {
    switch(this) {
      case UNKNOWN:
        return null;
      case BINARY:
        return "bin";
      case JSON:
        return "json";
      case TEXT:
        return "txt";
      case XML:
        return "xml";
      default:
        throw new MarkLogicInternalException("Unknown format "+this.toString());
    }
  }

  /**
   * Returns the format implied by the mime type
   * @param mimeType  the mime type
   * @return  the format
   */
  public static Format getFromMimetype(String mimeType) {
    if (mimeType == null)
      return UNKNOWN;
    else if (JSON_MIMETYPE_PATTERN.matcher(mimeType).matches())
      return JSON;
    else if (XML_MIMETYPE_PATTERN.matcher(mimeType).matches())
      return XML;
    else if (BINARY_MIMETYPE_PATTERN.matcher(mimeType).matches())
      return BINARY;
    else if (mimeType.startsWith("text/"))
      return TEXT;
    else return UNKNOWN;
  }

  /**
   * Returns the format based on a document data type
   * as used in Data Services.
   * @param dataType  the data type
   * @return  the format
   */
  public static Format getFromDataType(String dataType) {
    switch (dataType) {
      case "array":          return JSON;
      case "binaryDocument": return BINARY;
      case "jsonDocument":   return JSON;
      case "object":         return JSON;
      case "textDocument":   return TEXT;
      case "xmlDocument":    return XML;
      default:               return UNKNOWN;
    }
  }
}