/*
 * Copyright 2020-2030 码匠君<herodotus@aliyun.com>
 *
 * ThingsBrain licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * ThingsBrain 是 Dante Cloud 系统生态产品，采用 APACHE LICENSE 2.0 开源协议，您在使用过程中，需要注意以下几点：
 *
 * 1. 请不要删除和修改根目录下的LICENSE文件。
 * 2. 请不要删除和修改 ThingsBrain 源码头部的版权声明。
 * 3. 请保留源码和相关描述文件的项目出处，作者声明等。
 * 4. 分发源码时候，请注明软件出处 <https://gitee.com/dromara/dante-cloud>
 * 5. 在修改包名，模块名称，项目代码等时，请注明软件出处 <https://gitee.com/dromara/dante-cloud>
 * 6. 若您的项目无法满足以上几点，可申请商业授权
 */

package cn.herodotus.thingsbrain.kernel.commons.definition;

import cn.herodotus.thingsbrain.kernel.commons.domain.ValidationResult;
import tools.jackson.databind.JsonNode;
import tools.jackson.databind.ObjectMapper;

import java.util.Map;

/**
 * <p>Description: JsonSchema 校验定义 </p>
 *
 * @author : gengwei.zheng
 * @date : 2024/10/8 21:13
 */
public interface JsonSchemaValidator {

    /**
     * 获取指定的 {@link ObjectMapper}。
     * <p>
     * 特殊的 {@link ObjectMapper}，该 {@link ObjectMapper} 需要忽略空值处理。与系统统一的 {@link ObjectMapper} 有差异，系统统一 {@link ObjectMapper} 不会忽略空值。
     *
     * @return {@link ObjectMapper}
     */
    ObjectMapper getObjectMapper();

    /**
     * 根据 Schema 校验 JSON 数据值
     *
     * @param data   待校验数据 {@link JsonNode}
     * @param schema 用于校验的 Schema {@link JsonNode}
     * @return 校验结果 {@link ValidationResult}
     */
    ValidationResult validate(JsonNode data, JsonNode schema);

    /**
     * 根据 Schema 校验 JSON 数据值
     *
     * @param data   待校验数据 {@link Map}
     * @param schema 用于校验的 Schema {@link JsonNode}
     * @return 校验结果 {@link ValidationResult}
     */
    ValidationResult validate(Map<String, Object> data, JsonNode schema);

    /**
     * 根据 Schema 校验 JSON 数据值
     *
     * @param data   待校验数据 {@link Map}
     * @param schema 用于校验的 Schema
     * @return 校验结果 {@link ValidationResult}
     */
    ValidationResult validate(Map<String, Object> data, String schema);
}
