EntityProcessor.java

/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements.  See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package org.apache.stanbol.entityhub.indexing.core;

import org.apache.stanbol.entityhub.indexing.core.impl.IndexerImpl;
import org.apache.stanbol.entityhub.servicesapi.model.Representation;
import org.apache.stanbol.entityhub.servicesapi.yard.Yard;

public interface EntityProcessor extends IndexingComponent {
    /**
     * Processes the source representation based on some processing rules.
     * This interface is used by the {@link IndexerImpl} to process Entities
     * retrieved from the Source before they are stored to the {@link Yard}.
     * If a processor returns <code>null</code> for an parsed source than this
     * Entity is not indexed - filtered.
     * @param source the source
     * @return the processed/mapped representation or <code>null</code> to filter
     * (do not index) the parsed Representation
     */
    Representation process(Representation source);

}