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.converter.mapping;
18:
19: import org.compass.core.Resource;
20: import org.compass.core.converter.ConversionException;
21: import org.compass.core.converter.Converter;
22: import org.compass.core.mapping.ResourceMapping;
23: import org.compass.core.marshall.MarshallingContext;
24:
25: /**
26: * A converter associated with a {@link ResourceMapping} implementation. Allows to marhsall/unmarshall
27: * just ids as well.
28: *
29: * @author kimchy
30: */
31: public interface ResourceMappingConverter extends Converter {
32:
33: /**
34: * Marshalls teh given <code>Object</code> id into the given resource. Returns <code>true</code>
35: * if anything was was stored in the resource.
36: */
37: boolean marshallIds(Resource idResource, Object id,
38: ResourceMapping resourceMapping, MarshallingContext context)
39: throws ConversionException;
40:
41: /**
42: * Unamrshalls the given id into its id properties values.
43: */
44: Object[] unmarshallIds(Object id, ResourceMapping resourceMapping,
45: MarshallingContext context) throws ConversionException;
46: }
|