01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: */
18:
19: /* $Id: DocumentIdToPathMapper.java 586495 2007-10-19 15:13:36Z rfrovarp $ */
20:
21: package org.apache.lenya.cms.publication;
22:
23: import java.io.File;
24:
25: /**
26: * Document Id to Path mapper interface
27: */
28: public interface DocumentIdToPathMapper {
29:
30: /**
31: * Compute the document-path for a given publication, area and document-uuid. The file separator
32: * is the slash (/).
33: *
34: * @param uuid the UUID of the document
35: * @param language the language of the document
36: *
37: * @return the path to the document, without publication ID and area
38: */
39: String getPath(String uuid, String language);
40:
41: /**
42: * Compute the document-path for a given publication, area, document-uuid and language
43: *
44: * @param publication the publication of the document
45: * @param area the area of the document
46: * @param uuid the uuid of the document
47: * @param language the language of the document
48: *
49: * @return the path to the document
50: */
51: File getFile(Publication publication, String area, String uuid,
52: String language);
53:
54: }
|