Project

General

Profile

1 2916 jones
/**
2
 *  '$RCSfile$'
3
 *  Copyright: 2006 Regents of the University of California and the
4
 *             National Center for Ecological Analysis and Synthesis
5
 *
6
 *   '$Author$'
7
 *     '$Date$'
8
 * '$Revision$'
9
 *
10
 * This program is free software; you can redistribute it and/or modify
11
 * it under the terms of the GNU General Public License as published by
12
 * the Free Software Foundation; either version 2 of the License, or
13
 * (at your option) any later version.
14
 *
15
 * This program is distributed in the hope that it will be useful,
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 * GNU General Public License for more details.
19
 *
20
 * You should have received a copy of the GNU General Public License
21
 * along with this program; if not, write to the Free Software
22
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23
 */
24
package edu.ucsb.nceas.metacat;
25
26
import java.io.File;
27
import java.util.Hashtable;
28
29 4123 daigle
import edu.ucsb.nceas.metacat.service.PropertyService;
30
import edu.ucsb.nceas.metacat.service.ServiceException;
31 4080 daigle
import edu.ucsb.nceas.utilities.PropertyNotFoundException;
32 2916 jones
33
/**
34 4698 daigle
 * Generate a pathquery document representing a metacat query for a list of
35 2916 jones
 * document IDs.
36
 */
37 4698 daigle
public class DocumentIdQuery {
38 2916 jones
39 4698 daigle
	/**
40
	 * Create an squery parameters table using an already-initialized hashtable
41
	 *
42
	 * @param docidList
43
	 *            an array of document identifiers to search for
44
	 * @param params
45
	 *            the hashtable to add the query parameters to.
46
	 *
47
	 */
48
	public static Hashtable createDocidQueryParams(String[] docidList, Hashtable params) {
49
		params = getDefaultQueryParams();
50
		if (docidList != null) {
51
			params.put("/eml/@packageId", docidList);
52
		}
53
		return params;
54
	}
55 2916 jones
56 4698 daigle
	/**
57
	 * Create an squery using some preset values for the query parameters, only
58
	 * passing in the document ids to be searched.
59
	 *
60
	 * @param docidList
61
	 *            an array of document identifiers to search for
62
	 */
63
	public static String createDocidQuery(String[] docidList)
64
			throws PropertyNotFoundException {
65
		String pathQuery = "";
66
		Hashtable params = getDefaultQueryParams();
67
		if (docidList != null) {
68
			params.put("/eml/@packageId", docidList);
69
		}
70
71
		pathQuery = DBQuery.createSQuery(params);
72
		return pathQuery;
73
	}
74
75
	/**
76
	 * Create a paramter list containing default parameters for a query
77
	 *
78
	 * @return Hashtable containing the default parameters
79
	 */
80
	public static Hashtable getDefaultQueryParams() {
81
		Hashtable params = new Hashtable();
82
83
		String[] operator = new String[1];
84
		operator[0] = "UNION";
85
		params.put("operator", operator);
86
87
		String[] doctypes = new String[5];
88
		doctypes[0] = "eml://ecoinformatics.org/eml-2.0.1";
89
		doctypes[1] = "eml://ecoinformatics.org/eml-2.0.0";
90
		doctypes[2] = "-//ecoinformatics.org//eml-dataset-2.0.0beta6//EN";
91
		doctypes[3] = "-//ecoinformatics.org//eml-dataset-2.0.0beta4//EN";
92
		doctypes[4] = "metadata";
93
		params.put("returndoctype", doctypes);
94
95
		String[] fields = new String[11];
96
		fields[0] = "originator/individualName/surName";
97
		fields[1] = "originator/individualName/givenName";
98
		fields[2] = "creator/individualName/surName";
99
		fields[3] = "creator/individualName/givenName";
100
		fields[4] = "originator/organizationName";
101
		fields[5] = "creator/organizationName";
102
		fields[6] = "dataset/title";
103
		fields[7] = "keyword";
104
		fields[8] = "idinfo/citation/citeinfo/title";
105
		fields[9] = "idinfo/citation/citeinfo/origin";
106
		fields[10] = "idinfo/keywords/theme/themekey";
107
		params.put("returnfield", fields);
108
109
		return params;
110
	}
111
112
	/**
113
	 * Main method used for testing the class output
114
	 *
115
	 * @param args
116
	 *            no arguments used in this main method
117
	 */
118
	public static void main(String[] args) {
119
		String CONFIG_DIR = "lib";
120
		File dirPath = new File(CONFIG_DIR);
121
		try {
122
			PropertyService.getInstance();
123
		} catch (ServiceException ioe) {
124
			System.err.println("Error in loading properties: " + ioe.getMessage());
125
		}
126
127
		String[] ids = new String[3];
128
		ids[0] = "ces_dataset.23.1";
129
		ids[1] = "knb-lter-vcr.97.1";
130
		ids[2] = "obfs.400.1";
131
132
		String pathquery = null;
133
		try {
134
			pathquery = createDocidQuery(ids);
135
		} catch (PropertyNotFoundException pnfe) {
136
			System.out.println("Could not create doc id query: " + pnfe.getMessage());
137
		}
138
		System.out.println(pathquery);
139
	}
140
141 2916 jones
}