hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-12 12:33:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Browse classes

Browse Source 
git-svn-id: http://scm.dspace.org/svn/repo/trunk@64 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Peter Breton
2002-05-30 21:30:40 +00:00
parent eefb15465a
commit 12af9f5159
3 changed files with 2646 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2352
dspace/src/org/dspace/browse/Browse.java Normal file
View File

File diff suppressed because it is too large Load Diff

214
dspace/src/org/dspace/browse/BrowseInfo.java Normal file
View File

@@ -0,0 +1,214 @@
/*
* BrowseInfo.java
*
* Version: $Revision$
*
* Date: $Date$
*
* Copyright (c) 2001, Hewlett-Packard Company and Massachusetts
* Institute of Technology. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of the Hewlett-Packard Company nor the name of the
* Massachusetts Institute of Technology nor the names of their
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*/
package org.dspace.browse;
import java.util.*;
/**
* Results of DSpace Browse.
*
* The List RESULTS are the objects returned from the browse; either
* Strings (for getAuthors()) or org.dspace.content.Items (for all
* the getItems.... methods). The list is guaranteed to be non-null.
* You can use the usual list methods to access objects, determine
* how many objects have been returned, and so forth.
*
* overallPosition is the position of the first element of results
* within the Browse index. Positions begin with 0.
*
* total is the number of objects in the index. Note that this is a
* snapshot, which is only guaranteed to be correct at the time the
* browse method was called.
*
* offset is the position of the requested object within the results.
* This position is also 0-based.
*/
public class BrowseInfo
{
/**
* The results of the browse
*/
private java.util.List results;
/**
* The position of the first element of results
* within the Browse index. Positions begin with 0
*/
private int overallPosition;
/**
* The position of the requested object within the results.
* Offsets begin with 0.
*/
private int offset;
/**
* The total number of items in the browse index
*/
private int total;
/**
* Constructor
*
* @param results - A List of Browse results
* @param overallPosition - The position of the first returned item in the overall index
* @param total - The total number of items in the index
* @param offset - The position of the requested item in the set of results
*/
public BrowseInfo (List results,
int overallPosition,
int total,
int offset
)
{
this(results, null, null, overallPosition, total, offset);
}
/**
* Constructor
*
* @param results - A List of Browse results
* @param element - Results are sorted by dublin core ELEMENT and QUALIFIER
* @param qualifier - Results are sorted by dublin core ELEMENT and QUALIFIER
* @param overallPosition - The position of the first returned item in the overall index
* @param total - The total number of items in the index
* @param offset - The position of the requested item in the set of results
*/
public BrowseInfo (List results,
String element,
String qualifier,
int overallPosition,
int total,
int offset
)
{
if (results == null)
throw new IllegalArgumentException("Null result list not allowed");
// Sort the results as requested
// if (element != null)
// Collections.sort(results, new ItemComparator(type));
this.results = Collections.unmodifiableList(results);
this.overallPosition = overallPosition;
this.total = total;
this.offset = offset;
}
////////////////////////////////////////
// Accessor methods
////////////////////////////////////////
/**
* The results of the Browse.
* This can be either Strings (for the authors browse)
* or org.dspace.content.Items (for the other browses).
*
* @return - Result list. This list cannot be modified.
*/
public List getResults()
{
return results;
}
/**
* Return the number of results.
*/
public int getResultSize()
{
return results.size();
}
/**
* Return the position of the results in index being browsed.
* This is 0 for the start of the index.
*
* @return - The value of overallPosition
*/
public int getOverallPosition()
{
return overallPosition;
}
/**
* The total number of items in the index.
*
* @return - The value of total
*/
public int getTotal()
{
return total;
}
/**
* The position of the requested item in the set of results
*
* @return - The value of offset
*/
public int getOffset()
{
return offset;
}
////////////////////////////////////////
//
////////////////////////////////////////
/**
* True if these are no previous results from the browse
*/
public boolean isFirst()
{
return overallPosition == 0;
}
/**
* True if these are the last results from the browse
*/
public boolean isLast()
{
return overallPosition + results.size() == total;
}
}

80
dspace/src/org/dspace/browse/InitializeBrowse.java Normal file
View File

@@ -0,0 +1,80 @@
/*
* InitializeBrowse.java
*
* Version: $Revision$
*
* Date: $Date$
*
* Copyright (c) 2001, Hewlett-Packard Company and Massachusetts
* Institute of Technology. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of the Hewlett-Packard Company nor the name of the
* Massachusetts Institute of Technology nor the names of their
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*/
package org.dspace.browse;
import java.sql.SQLException;
import org.dspace.core.Context;
/**
* Creates Browse indexes
*
* @author Peter Breton
* @version $Revision$
*/
public class InitializeBrowse
{
/**
* Create Browse index, destroying the old one
*
* @param argv - Command-line arguments
*/
public static void main(String[] argv)
{
Context context = null;
try
{
context = new Context();
Browse.indexAll(context);
context.complete();
}
catch (SQLException sqle)
{
if (context != null)
context.abort();
System.out.println("Error: Browse index NOT created");
sqle.printStackTrace();
}
}
}