org.dspace.util.SolrUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation

DSpace core data model and service APIs.

The newest version!

/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */

package org.dspace.util;

import java.time.ZoneId;
import java.time.ZoneOffset;
import java.time.format.DateTimeFormatter;

/**
 * Common constants and static methods for working with Solr.
 *
 * @author Mark H. Wood 
 */
public class SolrUtils {
    /** Solr uses UTC always. */
    public static final ZoneId SOLR_TIME_ZONE = ZoneOffset.UTC;

    /** Restricted ISO 8601 format used by Solr. */
    public static final String SOLR_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";

    /** Do not instantiate. */
    private SolrUtils() { }

    /**
     * Create a formatter configured for Solr-style date strings and the UTC time zone.
     * @see #SOLR_DATE_FORMAT
     *
     * @return date formatter compatible with Solr.
     */
    public static DateTimeFormatter getDateFormatter() {
        // TODO: Can this be replaced with DateTimeFormatter.ISO_INSTANT?
        return DateTimeFormatter.ofPattern(SOLR_DATE_FORMAT).withZone(SOLR_TIME_ZONE);
    }
}