CompositeIndexTerm.java

/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed 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.kie.workbench.common.services.refactoring.model.index.terms;

import org.kie.workbench.common.services.refactoring.model.index.terms.valueterms.ValueIndexTerm;
import org.kie.workbench.common.services.refactoring.service.ResourceType;

/**
 * See {@link IndexTerm} for background.
 * </p>
 * A {@link CompositeIndexTerm} allows us to dynamically generate the keys for {@link ValueIndexTerm} instances.
 * </p>
 * For example, the {@link ReferenceIndexTerm} has a term with a prefix of "ref:" (returned by {@link #getTermBase()}
 * and a "suffix" that is determined when the {@link ReferenceIndexTerm} is instantiated (a {@link ResourceType} value).
 */
public interface CompositeIndexTerm extends IndexTerm {

    String getTermBase();

}