com.github.ydespreaux.spring.data.elasticsearch.core.EntityMapper Maven / Gradle / Ivy

/*
 * Copyright (C) 2018 Yoann Despréaux
 *
 * This program 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 2 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; see the file COPYING . If not, write to the
 * Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * Please send bugreports with examples or suggestions to [email protected]
 */

package com.github.ydespreaux.spring.data.elasticsearch.core;

import com.github.ydespreaux.spring.data.elasticsearch.core.mapping.ElasticsearchPersistentEntity;

/**
 * DocumentMapper interface, it will allow to customize how we mapping object to json
 *
 * @author Yoann Despréaux
 * @since 1.0.0
 */
public interface EntityMapper {

    /**
     * @param object the object to map
     * @return the string representation
     */
     String mapToString(T object);

    /**
     * @param source the json source
     * @param clazz  the item class
     * @param     generic type
     * @return the object corresponding to json source
     */
     S mapToObject(String source, Class clazz);

    /**
     * @param persistentEntity
     * @param 
     */
     void register(ElasticsearchPersistentEntity persistentEntity);
}