KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > outerj > daisy > cache > DocumentCache


1 /*
2  * Copyright 2004 Outerthought bvba and Schaubroeck nv
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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 package org.outerj.daisy.cache;
17
18 import org.outerj.daisy.repository.commonimpl.DocumentImpl;
19 import org.outerj.daisy.repository.AvailableVariants;
20
21 /**
22  * The service that caches Documents.
23  */
24 public interface DocumentCache {
25     public void put(long documentId, long branchId, long languageId, DocumentImpl document);
26
27     /**
28      * Returns the cached Document, or null if it is not in the cache.
29      */
30     public DocumentImpl get(long documentId, long branchId, long languageId);
31
32     /**
33      * Removes a cached Document, or does nothing if it is not in the cache.
34      */
35     public void remove(long documentId, long branchId, long languageId);
36
37     /**
38      * Removes all cached variants of the document.
39      */
40     public void remove(long documentId);
41
42     /**
43      * Clears the entire cache. Should only be used exceptionally to avoid performance drops.
44      */
45     public void clear();
46
47     public void put(long documentId, AvailableVariants availableVariants);
48
49     public AvailableVariants getAvailableVariants(long documentId);
50
51     public void removeAvailableVariants(long documentId);
52 }
53
Popular Tags