org.neo4j.kernel.impl.api.AbstractIndexKeyLengthValidator Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2018-2020 "Graph Foundation,"
 * Graph Foundation, Inc. [https://graphfoundation.org]
 *
 * This file is part of ONgDB.
 *
 * ONgDB 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 .
 */
/*
 * Copyright (c) 2002-2020 "Neo4j,"
 * Neo4j Sweden AB [http://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.kernel.impl.api;

import org.neo4j.kernel.impl.util.Validator;
import org.neo4j.values.storable.TextValue;
import org.neo4j.values.storable.Value;
import org.neo4j.values.storable.Values;

public abstract class AbstractIndexKeyLengthValidator implements Validator
{
    protected final int maxByteLength;
    private final int checkThreshold;

    protected AbstractIndexKeyLengthValidator( int maxByteLength )
    {
        this.maxByteLength = maxByteLength;

        // This check threshold is for not having to check every value that comes in, only those that may have a chance to exceed the max length.
        // The value 5 comes from a safer 4, which is the number of bytes that a max size UTF-8 code point needs.
        this.checkThreshold = maxByteLength / 5;
    }

    @Override
    public void validate( Value value )
    {
        if ( value == null || value == Values.NO_VALUE )
        {
            throw new IllegalArgumentException( "Null value" );
        }
        if ( Values.isTextValue( value ) && ((TextValue)value).length() >= checkThreshold )
        {
            int length = indexKeyLength( value );
            validateLength( length );
        }
    }

    void validateLength( int byteLength )
    {
        if ( byteLength > maxByteLength )
        {
            throw new IllegalArgumentException( "Property value size is too large for index. Please see index documentation for limitations." );
        }
    }

    protected abstract int indexKeyLength( Value value );
}