01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.core.config;
18:
19: import java.io.InputStream;
20:
21: import org.compass.core.CompassException;
22:
23: /**
24: * A general interface that can be used to resolve mappings definitions that are
25: * not supported by the default add configuration API's.
26: *
27: * @author kimchy
28: *
29: */
30: public interface InputStreamMappingResolver {
31:
32: /**
33: * Returns the name of the mapping builder. For example, for compass-core-mapping it should end
34: * with ".cpm.xml".
35: */
36: String getName();
37:
38: /**
39: * Returns an <code>InputStream</code> that holds the mapping.
40: *
41: * @return InputStream that has the mapping definitions.
42: * @throws CompassException
43: */
44: InputStream getMappingAsInputStream() throws CompassException;
45: }
|