blob: 1e26bfea7c56ae1e91230eacfe7738d155d47b2d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package org.libreoffice.report;
import java.io.IOException;
import java.io.InputStream;
/**
* This allows the job processor to load data from a repository. It is assumed,
* that all resource names are given as strings and furthermore, that the names
* identify a resource uniquely within the input repository.
*
* An input repository connects the report processing to the xml definitions.
* Unless defined otherwise, it is assumed, that the input-name is 'content.xml';
* possible other files are 'settings.xml' and 'styles.xml' (see the Oasis standard
* for details on these files and their contents).
*
*/
public interface InputRepository
{
/**
* Returns a unique identifier for this repository. Two repositories accessing
* the same location should return the same id. The identifier must never
* be null.
*
* @return the repository id
*/
Object getId();
InputStream createInputStream(final String name) throws IOException;
/** allows to access sub repositories inside this repository
*
* @param name describes the path to the sub repository
* @return the sub repository
* @throws java.io.IOException when the sub repository doesn't exist.
*/
InputRepository openInputRepository(final String name) throws IOException;
/**
* This returns a version number for the given resource. Return zero, if
* the resource is not versionable, else return a unique number for each version.
* As rule of thumb: Increase the version number by at least one for each change
* made to the resource.
*
* @param name the name of the resource
* @return the version number
*/
long getVersion(final String name);
boolean isReadable(final String name);
void closeInputRepository();
/** returns the URL of the database document
*
* @return the URL of the database document
*/
String getRootURL();
}
|
