org.elasticsearch.hadoop.serialization.builder.ValueParsingCallback Maven / Gradle / Ivy

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch 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.elasticsearch.hadoop.serialization.builder;

// Optional interface used by readers interested in knowing when a document hit starts and ends
// and also when metadata is being parsed vs the document core

// extended to provide event info about certain special events such as handling geo data
public interface ValueParsingCallback {

	void beginDoc();

	void beginLeadMetadata();

	void endLeadMetadata();

	void beginSource();
	
	void endSource();

	void excludeSource();

	void beginTrailMetadata();
	
	void endTrailMetadata();
	
	void endDoc();

    // Geo fields are special
    // add hooks for them so the parser is aware
    void beginGeoField();

    void endGeoField();
}