com.bluenimble.platform.indexer.Indexer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bluenimble-jvm-sdk Show documentation

BlueNimble Serverless SDK

There is a newer version: 2.50.0

/*
 * 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 com.bluenimble.platform.indexer;

import com.bluenimble.platform.Feature;
import com.bluenimble.platform.json.JsonArray;
import com.bluenimble.platform.json.JsonObject;
import com.bluenimble.platform.query.Query;

@Feature ( name = "indexer" )
public interface Indexer {
	
	interface Bulk {
		String Create = "create";
		String Update = "update";
		String Delete = "delete";
	}
	
	interface Visitor {
		boolean onRecord (JsonArray columns, JsonObject record);
	}
	
	boolean 		exists 		(String entity) 												throws IndexerException;
	JsonObject 		create 		(String entity, JsonObject definition) 							throws IndexerException;
	JsonObject 		describe 	(String entity) 												throws IndexerException;
	
	JsonObject 		clear 		(String entity) 												throws IndexerException;
	
	JsonObject 		put 		(String entity, JsonObject doc) 								throws IndexerException;
	JsonObject 		get 		(String entity, String id) 										throws IndexerException;
	//JsonObject 		update 		(String [] entities, JsonObject query, JsonObject doc) 			throws IndexerException;
	JsonObject 		update 		(String entity, JsonObject doc, boolean partial) 				throws IndexerException;
	JsonObject 		delete 		(String entity, String id) 										throws IndexerException;
	JsonObject 		bulk 		(JsonObject payload) 											throws IndexerException;
	
	JsonObject 		search 		(JsonObject query, String [] entities) 							throws IndexerException;
	long 			count 		(JsonObject query, String [] entities) 							throws IndexerException;
	
	void			find 		(Query query, Visitor visitor) 									throws IndexerException;
	JsonObject		findOne 	(Query query) 													throws IndexerException;
}