org.neo4j.values.AnyValues Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-values Show documentation

Neo4j property value system.

The newest version!

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.values;

import java.util.Comparator;
import org.neo4j.values.storable.Values;
import org.neo4j.values.virtual.VirtualValueGroup;

@SuppressWarnings("WeakerAccess")
public final class AnyValues {
    /**
     * Default AnyValue comparator. Will correctly compare all storable and virtual values.
     *
     * 
     * Orderability
     *
     * 
     *   The Cypher CIP defining orderability
     * 
     *
     * 
     * Ascending global sort order of disjoint types:
     *
     * 

     *    MAP types
     *   
     *      Regular map
     *
     *     
 NODE
     *
     *     
 RELATIONSHIP
     *   
     *
     *  
 LIST
     *
     *  
 PATH
     *
     *  
 POINT
     *
     *  
 STRING
     *
     *  
 BOOLEAN
     *
     *  
 NUMBER
     *    
     *       NaN values are treated as the largest numbers in orderability only (i.e. they are put after positive infinity)
     *    
     *  
 VOID (i.e. the type of null)
     * 
     */
    private static final AnyValueComparator comp =
            new AnyValueComparator(Values.COMPARATOR, VirtualValueGroup::compareTo);

    public static final Comparator COMPARATOR = comp;
    public static final TernaryComparator TERNARY_COMPARATOR = comp;
}