org.apache.solr.common.SolrDocumentBase Maven / Gradle / Ivy
/*
* 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.solr.common;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;
public abstract class SolrDocumentBase implements Map, Serializable {
/** Get all field names.
*/
public abstract Collection getFieldNames();
/** Set a field with implied null value for boost.
* @param name name of the field to set
* @param value value of the field
*/
public abstract void setField(String name, Object value);
/**
* Add a field to the document.
* @param name Name of the field, should match one of the field names defined under "fields" tag in schema.xml.
* @param value Value of the field, should be of same class type as defined by "type" attribute of the corresponding field in schema.xml.
*/
public abstract void addField(String name, Object value);
/**
* Get the first value or collection of values for a given field.
*/
public abstract Object getFieldValue(String name);
/**
* Get a collection of values for a given field name
*/
public abstract Collection getFieldValues(String name);
public abstract void addChildDocument(K child);
public abstract void addChildDocuments(Collection children);
public abstract List getChildDocuments();
public abstract boolean hasChildDocuments();
public abstract int getChildDocumentCount();
}