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: PathToDocumentIdMapper.java 473861 2006-11-12 03:51:14Z gregor $ */
20:
21: package org.apache.lenya.cms.publication;
22:
23: import java.io.File;
24:
25: /**
26: * This interface is basically the reverse of DocumentIdToPathMapper.
27: */
28: public interface PathToDocumentIdMapper {
29:
30: /**
31: * Compute the document-id for a given file.
32: * @param publication the publication where the file is.
33: * @param area the area where the file is.
34: * @param file the file that is associated with the document
35: * @return the document-id of the document associated with the given file.
36: * @throws DocumentDoesNotExistException if there is no document associated with this file.
37: */
38: String getDocumentId(Publication publication, String area, File file)
39: throws DocumentDoesNotExistException;
40:
41: /**
42: * Returns the language for a given file
43: * @param file the document file
44: * @return the language for the given document file or null if the file
45: * has no language.
46: */
47: public String getLanguage(File file);
48:
49: }
|