mirror of
https://github.com/DSpace/DSpace.git
synced 2025-10-14 21:43:11 +00:00
Fight scroll blindness: fix many broken doc comments.
Also many small typos in comments. Some small reformatting for readability. git-svn-id: http://scm.dspace.org/svn/repo/dspace/trunk@5124 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
@@ -75,7 +75,7 @@ public class AddBitstreamsAction extends UpdateBitstreamsAction {
|
|||||||
* Adds bitstreams from the archive as listed in the contents file.
|
* Adds bitstreams from the archive as listed in the contents file.
|
||||||
*
|
*
|
||||||
* @param context
|
* @param context
|
||||||
* @param ItemArchive
|
* @param itarch
|
||||||
* @param isTest
|
* @param isTest
|
||||||
* @param suppressUndo
|
* @param suppressUndo
|
||||||
* @throws IllegalArgumentException
|
* @throws IllegalArgumentException
|
||||||
@@ -84,8 +84,9 @@ public class AddBitstreamsAction extends UpdateBitstreamsAction {
|
|||||||
* @throws AuthorizeException
|
* @throws AuthorizeException
|
||||||
* @throws SQLException
|
* @throws SQLException
|
||||||
*/
|
*/
|
||||||
public void execute(Context context, ItemArchive itarch, boolean isTest, boolean suppressUndo)
|
public void execute(Context context, ItemArchive itarch, boolean isTest,
|
||||||
throws IllegalArgumentException, ParseException, IOException, AuthorizeException, SQLException
|
boolean suppressUndo) throws IllegalArgumentException,
|
||||||
|
ParseException, IOException, AuthorizeException, SQLException
|
||||||
{
|
{
|
||||||
Item item = itarch.getItem();
|
Item item = itarch.getItem();
|
||||||
File dir = itarch.getDirectory();
|
File dir = itarch.getDirectory();
|
||||||
|
@@ -57,14 +57,14 @@ public class AddMetadataAction extends UpdateMetadataAction {
|
|||||||
* Adds metadata specified in the source archive
|
* Adds metadata specified in the source archive
|
||||||
*
|
*
|
||||||
* @param context
|
* @param context
|
||||||
* @param ItemArchive
|
* @param itarch
|
||||||
* @param isTest
|
* @param isTest
|
||||||
* @param suppressUndo
|
* @param suppressUndo
|
||||||
* @throws AuthorizeException
|
* @throws AuthorizeException
|
||||||
* @throws SQLException
|
* @throws SQLException
|
||||||
*/
|
*/
|
||||||
public void execute(Context context, ItemArchive itarch, boolean isTest, boolean suppressUndo)
|
public void execute(Context context, ItemArchive itarch, boolean isTest,
|
||||||
throws AuthorizeException, SQLException
|
boolean suppressUndo) throws AuthorizeException, SQLException
|
||||||
{
|
{
|
||||||
Item item = itarch.getItem();
|
Item item = itarch.getItem();
|
||||||
String dirname = itarch.getDirectoryName();
|
String dirname = itarch.getDirectoryName();
|
||||||
|
@@ -60,7 +60,7 @@ public class BitstreamFilterByBundleName extends BitstreamFilter {
|
|||||||
*
|
*
|
||||||
* @param bitstream
|
* @param bitstream
|
||||||
* @throws BitstreamFilterException
|
* @throws BitstreamFilterException
|
||||||
* @returns whether bitstream is in bundle
|
* @return whether bitstream is in bundle
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
public boolean accept(Bitstream bitstream)
|
public boolean accept(Bitstream bitstream)
|
||||||
|
@@ -59,7 +59,7 @@ public class BitstreamFilterByFilename extends BitstreamFilter {
|
|||||||
* Tests bitstream by matching the regular expression in the
|
* Tests bitstream by matching the regular expression in the
|
||||||
* properties against the bitstream name
|
* properties against the bitstream name
|
||||||
*
|
*
|
||||||
* @returns whether bitstream name matches the regular expression
|
* @return whether bitstream name matches the regular expression
|
||||||
*/
|
*/
|
||||||
public boolean accept(Bitstream bitstream) throws BitstreamFilterException
|
public boolean accept(Bitstream bitstream) throws BitstreamFilterException
|
||||||
{
|
{
|
||||||
|
@@ -64,7 +64,7 @@ public class DeleteBitstreamsAction extends UpdateBitstreamsAction
|
|||||||
* Delete bitstream from item
|
* Delete bitstream from item
|
||||||
*
|
*
|
||||||
* @param context
|
* @param context
|
||||||
* @param ItemArchive
|
* @param itarch
|
||||||
* @param isTest
|
* @param isTest
|
||||||
* @param suppressUndo
|
* @param suppressUndo
|
||||||
* @throws IllegalArgumentException
|
* @throws IllegalArgumentException
|
||||||
@@ -73,8 +73,9 @@ public class DeleteBitstreamsAction extends UpdateBitstreamsAction
|
|||||||
* @throws AuthorizeException
|
* @throws AuthorizeException
|
||||||
* @throws SQLException
|
* @throws SQLException
|
||||||
*/
|
*/
|
||||||
public void execute(Context context, ItemArchive itarch, boolean isTest, boolean suppressUndo)
|
public void execute(Context context, ItemArchive itarch, boolean isTest,
|
||||||
throws IllegalArgumentException, IOException, SQLException, AuthorizeException, ParseException
|
boolean suppressUndo) throws IllegalArgumentException, IOException,
|
||||||
|
SQLException, AuthorizeException, ParseException
|
||||||
{
|
{
|
||||||
File f = new File(itarch.getDirectory(), ItemUpdate.DELETE_CONTENTS_FILE);
|
File f = new File(itarch.getDirectory(), ItemUpdate.DELETE_CONTENTS_FILE);
|
||||||
if (!f.exists())
|
if (!f.exists())
|
||||||
|
@@ -88,7 +88,7 @@ public class DeleteBitstreamsByFilterAction extends UpdateBitstreamsAction {
|
|||||||
* Delete bitstream
|
* Delete bitstream
|
||||||
*
|
*
|
||||||
* @param context
|
* @param context
|
||||||
* @param ItemArchive
|
* @param itarch
|
||||||
* @param isTest
|
* @param isTest
|
||||||
* @param suppressUndo
|
* @param suppressUndo
|
||||||
* @throws IllegalArgumentException
|
* @throws IllegalArgumentException
|
||||||
@@ -97,8 +97,9 @@ public class DeleteBitstreamsByFilterAction extends UpdateBitstreamsAction {
|
|||||||
* @throws AuthorizeException
|
* @throws AuthorizeException
|
||||||
* @throws SQLException
|
* @throws SQLException
|
||||||
*/
|
*/
|
||||||
public void execute(Context context, ItemArchive itarch, boolean isTest, boolean suppressUndo)
|
public void execute(Context context, ItemArchive itarch, boolean isTest,
|
||||||
throws AuthorizeException, BitstreamFilterException, IOException, ParseException, SQLException
|
boolean suppressUndo) throws AuthorizeException,
|
||||||
|
BitstreamFilterException, IOException, ParseException, SQLException
|
||||||
{
|
{
|
||||||
|
|
||||||
List<String> deleted = new ArrayList<String>();
|
List<String> deleted = new ArrayList<String>();
|
||||||
|
@@ -55,14 +55,14 @@ public class DeleteMetadataAction extends UpdateMetadataAction {
|
|||||||
* Delete metadata from item
|
* Delete metadata from item
|
||||||
*
|
*
|
||||||
* @param context
|
* @param context
|
||||||
* @param ItemArchive
|
* @param itarch
|
||||||
* @param isTest
|
* @param isTest
|
||||||
* @param suppressUndo
|
* @param suppressUndo
|
||||||
* @throws ParseException
|
* @throws ParseException
|
||||||
* @throws AuthorizeException
|
* @throws AuthorizeException
|
||||||
*/
|
*/
|
||||||
public void execute(Context context, ItemArchive itarch, boolean isTest, boolean suppressUndo)
|
public void execute(Context context, ItemArchive itarch, boolean isTest,
|
||||||
throws AuthorizeException, ParseException
|
boolean suppressUndo) throws AuthorizeException, ParseException
|
||||||
{
|
{
|
||||||
Item item = itarch.getItem();
|
Item item = itarch.getItem();
|
||||||
for (String f : targetFields)
|
for (String f : targetFields)
|
||||||
|
@@ -57,7 +57,7 @@ public class OriginalBitstreamFilter extends BitstreamFilterByBundleName
|
|||||||
/**
|
/**
|
||||||
* Tests bitstreams for containment in an ORIGINAL bundle
|
* Tests bitstreams for containment in an ORIGINAL bundle
|
||||||
*
|
*
|
||||||
* @returns true if the bitstream is in the ORIGINAL bundle
|
* @return true if the bitstream is in the ORIGINAL bundle
|
||||||
*
|
*
|
||||||
* @throws BitstreamFilterException
|
* @throws BitstreamFilterException
|
||||||
*/
|
*/
|
||||||
|
@@ -60,7 +60,7 @@ public class OriginalWithDerivativesBitstreamFilter extends BitstreamFilter
|
|||||||
*
|
*
|
||||||
* @param bitstream
|
* @param bitstream
|
||||||
* @throws BitstreamFilterException
|
* @throws BitstreamFilterException
|
||||||
* @returns true if bitstream is in specified bundles
|
* @return true if bitstream is in specified bundles
|
||||||
*/
|
*/
|
||||||
public boolean accept(Bitstream bitstream)
|
public boolean accept(Bitstream bitstream)
|
||||||
throws BitstreamFilterException
|
throws BitstreamFilterException
|
||||||
|
@@ -65,8 +65,8 @@ public class Brand
|
|||||||
/**
|
/**
|
||||||
* Constructor to set up footer image attributes.
|
* Constructor to set up footer image attributes.
|
||||||
*
|
*
|
||||||
* @param footerWidth length of the footer in pixels
|
* @param brandWidth length of the footer in pixels
|
||||||
* @param footerHeight height of the footer in pixels
|
* @param brandHeight height of the footer in pixels
|
||||||
* @param font font to use for text on the footer
|
* @param font font to use for text on the footer
|
||||||
* @param xOffset number of pixels text should be indented from left-hand side of footer
|
* @param xOffset number of pixels text should be indented from left-hand side of footer
|
||||||
*
|
*
|
||||||
|
@@ -322,7 +322,6 @@ public class GenerateSitemaps
|
|||||||
* @param engineURL
|
* @param engineURL
|
||||||
* Search engine URL minus protocol etc, e.g.
|
* Search engine URL minus protocol etc, e.g.
|
||||||
* {@code www.google.com}
|
* {@code www.google.com}
|
||||||
* @return {@code true} if the operation was successful
|
|
||||||
* @throws MalformedURLException
|
* @throws MalformedURLException
|
||||||
* if the passed in URL is malformed
|
* if the passed in URL is malformed
|
||||||
* @throws UnsupportedEncodingException
|
* @throws UnsupportedEncodingException
|
||||||
|
@@ -53,7 +53,7 @@ import org.dspace.core.Context;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* This class is an addition to the AuthorizeManager that perform authorization
|
* This class is an addition to the AuthorizeManager that perform authorization
|
||||||
* check on not crud (ADD, WRITE, etc.) actions.
|
* check on not CRUD (ADD, WRITE, etc.) actions.
|
||||||
*
|
*
|
||||||
* @author bollini
|
* @author bollini
|
||||||
*
|
*
|
||||||
@@ -522,7 +522,7 @@ public class AuthorizeUtil
|
|||||||
/**
|
/**
|
||||||
* Can the current user remove or edit the supplied policy?
|
* Can the current user remove or edit the supplied policy?
|
||||||
*
|
*
|
||||||
* @param context
|
* @param c
|
||||||
* the DSpace Context Object
|
* the DSpace Context Object
|
||||||
* @param rp
|
* @param rp
|
||||||
* a resource policy
|
* a resource policy
|
||||||
@@ -607,7 +607,7 @@ public class AuthorizeUtil
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Can the current user reistate the item?
|
* Can the current user reinstate the item?
|
||||||
*
|
*
|
||||||
* @param context
|
* @param context
|
||||||
* the DSpace Context Object
|
* the DSpace Context Object
|
||||||
@@ -617,7 +617,7 @@ public class AuthorizeUtil
|
|||||||
* if a db error occur
|
* if a db error occur
|
||||||
* @throws AuthorizeException
|
* @throws AuthorizeException
|
||||||
* if the current user is not allowed to perform the item
|
* if the current user is not allowed to perform the item
|
||||||
* reistate
|
* reinstatement
|
||||||
*/
|
*/
|
||||||
public static void authorizeReinstateItem(Context context, Item item)
|
public static void authorizeReinstateItem(Context context, Item item)
|
||||||
throws SQLException, AuthorizeException
|
throws SQLException, AuthorizeException
|
||||||
|
@@ -112,8 +112,10 @@ public class DCInput
|
|||||||
* Class constructor for creating a DCInput object based on the contents of
|
* Class constructor for creating a DCInput object based on the contents of
|
||||||
* a HashMap
|
* a HashMap
|
||||||
*
|
*
|
||||||
* @param row
|
* @param fieldMap
|
||||||
* the corresponding row in the table
|
* ???
|
||||||
|
* @param listMap
|
||||||
|
* ?the corresponding row in the table?
|
||||||
*/
|
*/
|
||||||
public DCInput(Map fieldMap, Map listMap)
|
public DCInput(Map fieldMap, Map listMap)
|
||||||
{
|
{
|
||||||
@@ -339,11 +341,9 @@ public class DCInput
|
|||||||
* Gets the display string that corresponds to the passed storage string in
|
* Gets the display string that corresponds to the passed storage string in
|
||||||
* a particular display-storage pair set.
|
* a particular display-storage pair set.
|
||||||
*
|
*
|
||||||
* @param allPairs
|
|
||||||
* HashMap of all display-storage pair sets
|
|
||||||
* @param pairTypeName
|
* @param pairTypeName
|
||||||
* Name of display-storage pair set to search
|
* Name of display-storage pair set to search
|
||||||
* @param storageString
|
* @param storedString
|
||||||
* the string that gets stored
|
* the string that gets stored
|
||||||
*
|
*
|
||||||
* @return the displayed string whose selection causes storageString to be
|
* @return the displayed string whose selection causes storageString to be
|
||||||
@@ -368,11 +368,9 @@ public class DCInput
|
|||||||
* Gets the stored string that corresponds to the passed display string in a
|
* Gets the stored string that corresponds to the passed display string in a
|
||||||
* particular display-storage pair set.
|
* particular display-storage pair set.
|
||||||
*
|
*
|
||||||
* @param allPairs
|
|
||||||
* HashMap of all display-storage pair sets
|
|
||||||
* @param pairTypeName
|
* @param pairTypeName
|
||||||
* Name of display-storage pair set to search
|
* Name of display-storage pair set to search
|
||||||
* @param displayString
|
* @param displayedString
|
||||||
* the string that gets displayed
|
* the string that gets displayed
|
||||||
*
|
*
|
||||||
* @return the string that gets stored when displayString gets selected,
|
* @return the string that gets stored when displayString gets selected,
|
||||||
|
@@ -399,7 +399,7 @@ public class SyndicationFeed
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @add a ROME plugin module (e.g. for OpenSearch) at the feed level
|
* Add a ROME plugin module (e.g. for OpenSearch) at the feed level.
|
||||||
*/
|
*/
|
||||||
public void addModule(Module m)
|
public void addModule(Module m)
|
||||||
{
|
{
|
||||||
|
@@ -372,7 +372,7 @@ public class ShibAuthentication implements AuthenticationMethod
|
|||||||
* DSpace context
|
* DSpace context
|
||||||
* @param request
|
* @param request
|
||||||
* HTTP request, in case anything in that is used to decide
|
* HTTP request, in case anything in that is used to decide
|
||||||
* @param email
|
* @param username
|
||||||
* e-mail address of user attempting to register
|
* e-mail address of user attempting to register
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@@ -486,8 +486,8 @@ public class X509Authentication implements AuthenticationMethod
|
|||||||
* Return special groups configured in dspace.cfg for X509 certificate
|
* Return special groups configured in dspace.cfg for X509 certificate
|
||||||
* authentication.
|
* authentication.
|
||||||
*
|
*
|
||||||
* @param Context
|
* @param context
|
||||||
* @param HttpServletRequest
|
* @param request
|
||||||
* object potentially containing the cert
|
* object potentially containing the cert
|
||||||
*
|
*
|
||||||
* @return An int array of group IDs
|
* @return An int array of group IDs
|
||||||
|
@@ -330,7 +330,7 @@ public class AuthorizeConfiguration
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Are community admins allowed to reinstatiate an item from them
|
* Are community admins allowed to reinstate an item from them
|
||||||
* collections?
|
* collections?
|
||||||
*
|
*
|
||||||
* @return
|
* @return
|
||||||
@@ -459,7 +459,7 @@ public class AuthorizeConfiguration
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Are collection admins allowed to reinstatiate an item from the
|
* Are collection admins allowed to reinstate an item from the
|
||||||
* collection?
|
* collection?
|
||||||
*
|
*
|
||||||
* @return
|
* @return
|
||||||
|
@@ -119,13 +119,13 @@ public class BrowseInfo
|
|||||||
/** offset of the item at the top of the previous page */
|
/** offset of the item at the top of the previous page */
|
||||||
private int prevOffset = -1;
|
private int prevOffset = -1;
|
||||||
|
|
||||||
/** the value upon which we are focussing */
|
/** the value upon which we are focusing */
|
||||||
private String focus;
|
private String focus;
|
||||||
|
|
||||||
/** number of resutls to display per page */
|
/** number of results to display per page */
|
||||||
private int resultsPerPage = -1;
|
private int resultsPerPage = -1;
|
||||||
|
|
||||||
/** database id of the item upon which we are focussing */
|
/** database id of the item upon which we are focusing */
|
||||||
private int focusItem = -1;
|
private int focusItem = -1;
|
||||||
|
|
||||||
/** number of metadata elements to display before truncating using "et al" */
|
/** number of metadata elements to display before truncating using "et al" */
|
||||||
@@ -340,7 +340,7 @@ public class BrowseInfo
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param id the database id of the item at the top of the next page
|
* @param offset the database id of the item at the top of the next page
|
||||||
*/
|
*/
|
||||||
public void setNextOffset(int offset)
|
public void setNextOffset(int offset)
|
||||||
{
|
{
|
||||||
@@ -396,7 +396,7 @@ public class BrowseInfo
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param prevItem The prevItem to set.
|
* @param prevOffset The prevOffset to set.
|
||||||
*/
|
*/
|
||||||
public void setPrevOffset(int prevOffset)
|
public void setPrevOffset(int prevOffset)
|
||||||
{
|
{
|
||||||
@@ -460,7 +460,7 @@ public class BrowseInfo
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param value The authority key to set.
|
* @param authority The authority key to set.
|
||||||
*/
|
*/
|
||||||
public void setAuthority(String authority)
|
public void setAuthority(String authority)
|
||||||
{
|
{
|
||||||
|
@@ -301,7 +301,7 @@ public final class CheckerCommand
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* <p>
|
* <p>
|
||||||
* Process general case bistream.
|
* Process general case bitstream.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* <p>
|
* <p>
|
||||||
@@ -351,7 +351,7 @@ public final class CheckerCommand
|
|||||||
}
|
}
|
||||||
catch (SQLException e)
|
catch (SQLException e)
|
||||||
{
|
{
|
||||||
// ??this code only executes if an sql
|
// ??this code only executes if an SQL
|
||||||
// exception occurs in *DSpace* code, probably
|
// exception occurs in *DSpace* code, probably
|
||||||
// indicating a general db problem?
|
// indicating a general db problem?
|
||||||
info
|
info
|
||||||
@@ -453,7 +453,7 @@ public final class CheckerCommand
|
|||||||
/**
|
/**
|
||||||
* Set report errors only
|
* Set report errors only
|
||||||
*
|
*
|
||||||
* @param reportErrorsOnly
|
* @param reportVerbose
|
||||||
* true to report only errors in the logs.
|
* true to report only errors in the logs.
|
||||||
*/
|
*/
|
||||||
public void setReportVerbose(boolean reportVerbose)
|
public void setReportVerbose(boolean reportVerbose)
|
||||||
|
@@ -74,9 +74,6 @@ public class SimpleReporterImpl implements SimpleReporter
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Main Constructor.
|
* Main Constructor.
|
||||||
*
|
|
||||||
* @param reporter
|
|
||||||
* reporter to select the information
|
|
||||||
*/
|
*/
|
||||||
public SimpleReporterImpl()
|
public SimpleReporterImpl()
|
||||||
{
|
{
|
||||||
@@ -84,7 +81,7 @@ public class SimpleReporterImpl implements SimpleReporter
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sends the Deleteted bitstream report to an administrator. for the
|
* Sends the Deleted bitstream report to an administrator. for the
|
||||||
* specified date range.
|
* specified date range.
|
||||||
*
|
*
|
||||||
* @param startDate
|
* @param startDate
|
||||||
|
@@ -66,7 +66,7 @@ public abstract class DSpaceObject
|
|||||||
* separates entries with a comma.
|
* separates entries with a comma.
|
||||||
* Subclass can just start calling addDetails, since it creates
|
* Subclass can just start calling addDetails, since it creates
|
||||||
* the cache if it needs to.
|
* the cache if it needs to.
|
||||||
* @param detail detail string to add.
|
* @param d detail string to add.
|
||||||
*/
|
*/
|
||||||
protected void addDetails(String d)
|
protected void addDetails(String d)
|
||||||
{
|
{
|
||||||
@@ -77,7 +77,7 @@ public abstract class DSpaceObject
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns summary of event details, or null if there are none.
|
* @return summary of event details, or null if there are none.
|
||||||
*/
|
*/
|
||||||
protected String getDetails()
|
protected String getDetails()
|
||||||
{
|
{
|
||||||
|
@@ -604,7 +604,7 @@ public class Item extends DSpaceObject
|
|||||||
* @param element
|
* @param element
|
||||||
* the Dublin Core element
|
* the Dublin Core element
|
||||||
* @param qualifier
|
* @param qualifier
|
||||||
* the Dublin Core qualifer, or <code>null</code> for
|
* the Dublin Core qualifier, or <code>null</code> for
|
||||||
* unqualified
|
* unqualified
|
||||||
* @param lang
|
* @param lang
|
||||||
* the ISO639 language code, optionally followed by an underscore
|
* the ISO639 language code, optionally followed by an underscore
|
||||||
@@ -627,7 +627,7 @@ public class Item extends DSpaceObject
|
|||||||
* @param element
|
* @param element
|
||||||
* the Dublin Core element
|
* the Dublin Core element
|
||||||
* @param qualifier
|
* @param qualifier
|
||||||
* the Dublin Core qualifer, or <code>null</code> for
|
* the Dublin Core qualifier, or <code>null</code> for
|
||||||
* unqualified
|
* unqualified
|
||||||
* @param lang
|
* @param lang
|
||||||
* the ISO639 language code, optionally followed by an underscore
|
* the ISO639 language code, optionally followed by an underscore
|
||||||
@@ -657,7 +657,7 @@ public class Item extends DSpaceObject
|
|||||||
* @param element
|
* @param element
|
||||||
* the metadata element name
|
* the metadata element name
|
||||||
* @param qualifier
|
* @param qualifier
|
||||||
* the metadata qualifer name, or <code>null</code> for
|
* the metadata qualifier name, or <code>null</code> for
|
||||||
* unqualified
|
* unqualified
|
||||||
* @param lang
|
* @param lang
|
||||||
* the ISO639 language code, optionally followed by an underscore
|
* the ISO639 language code, optionally followed by an underscore
|
||||||
@@ -697,7 +697,7 @@ public class Item extends DSpaceObject
|
|||||||
* @param element
|
* @param element
|
||||||
* the metadata element name
|
* the metadata element name
|
||||||
* @param qualifier
|
* @param qualifier
|
||||||
* the metadata qualifer name, or <code>null</code> for
|
* the metadata qualifier name, or <code>null</code> for
|
||||||
* unqualified
|
* unqualified
|
||||||
* @param lang
|
* @param lang
|
||||||
* the ISO639 language code, optionally followed by an underscore
|
* the ISO639 language code, optionally followed by an underscore
|
||||||
@@ -705,9 +705,9 @@ public class Item extends DSpaceObject
|
|||||||
* value has no language (for example, a date).
|
* value has no language (for example, a date).
|
||||||
* @param values
|
* @param values
|
||||||
* the values to add.
|
* the values to add.
|
||||||
* @param authority
|
* @param authorities
|
||||||
* the external authority key for this value (or null)
|
* the external authority key for this value (or null)
|
||||||
* @param confidence
|
* @param confidences
|
||||||
* the authority confidence (default 0)
|
* the authority confidence (default 0)
|
||||||
*/
|
*/
|
||||||
public void addMetadata(String schema, String element, String qualifier, String lang,
|
public void addMetadata(String schema, String element, String qualifier, String lang,
|
||||||
@@ -793,7 +793,7 @@ public class Item extends DSpaceObject
|
|||||||
* @param element
|
* @param element
|
||||||
* the metadata element name
|
* the metadata element name
|
||||||
* @param qualifier
|
* @param qualifier
|
||||||
* the metadata qualifer, or <code>null</code> for
|
* the metadata qualifier, or <code>null</code> for
|
||||||
* unqualified
|
* unqualified
|
||||||
* @param lang
|
* @param lang
|
||||||
* the ISO639 language code, optionally followed by an underscore
|
* the ISO639 language code, optionally followed by an underscore
|
||||||
@@ -821,7 +821,7 @@ public class Item extends DSpaceObject
|
|||||||
* @param element
|
* @param element
|
||||||
* the metadata element name
|
* the metadata element name
|
||||||
* @param qualifier
|
* @param qualifier
|
||||||
* the metadata qualifer, or <code>null</code> for
|
* the metadata qualifier, or <code>null</code> for
|
||||||
* unqualified
|
* unqualified
|
||||||
* @param lang
|
* @param lang
|
||||||
* the ISO639 language code, optionally followed by an underscore
|
* the ISO639 language code, optionally followed by an underscore
|
||||||
@@ -921,7 +921,7 @@ public class Item extends DSpaceObject
|
|||||||
* method will return <code>true</code> if the given schema,
|
* method will return <code>true</code> if the given schema,
|
||||||
* element, qualifier and language match the schema, element,
|
* element, qualifier and language match the schema, element,
|
||||||
* qualifier and language of the <code>DCValue</code> object passed
|
* qualifier and language of the <code>DCValue</code> object passed
|
||||||
* in. Any or all of the elemenent, qualifier and language passed
|
* in. Any or all of the element, qualifier and language passed
|
||||||
* in can be the <code>Item.ANY</code> wildcard.
|
* in can be the <code>Item.ANY</code> wildcard.
|
||||||
*
|
*
|
||||||
* @param schema
|
* @param schema
|
||||||
@@ -1942,7 +1942,7 @@ public class Item extends DSpaceObject
|
|||||||
// FIXME: there is an exception handling problem here
|
// FIXME: there is an exception handling problem here
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
// Remove from indicies
|
// Remove from indices
|
||||||
IndexBrowse ib = new IndexBrowse(ourContext);
|
IndexBrowse ib = new IndexBrowse(ourContext);
|
||||||
ib.itemRemoved(this);
|
ib.itemRemoved(this);
|
||||||
}
|
}
|
||||||
@@ -2171,7 +2171,7 @@ public class Item extends DSpaceObject
|
|||||||
Constants.DEFAULT_ITEM_READ);
|
Constants.DEFAULT_ITEM_READ);
|
||||||
|
|
||||||
// change the action to just READ
|
// change the action to just READ
|
||||||
// just don't call update on the resourcepolicies!!!
|
// just don't call update on the resource policies!!!
|
||||||
Iterator i = policies.iterator();
|
Iterator i = policies.iterator();
|
||||||
|
|
||||||
// MUST have default policies
|
// MUST have default policies
|
||||||
@@ -2193,7 +2193,7 @@ public class Item extends DSpaceObject
|
|||||||
Constants.DEFAULT_BITSTREAM_READ);
|
Constants.DEFAULT_BITSTREAM_READ);
|
||||||
|
|
||||||
// change the action to just READ
|
// change the action to just READ
|
||||||
// just don't call update on the resourcepolicies!!!
|
// just don't call update on the resource policies!!!
|
||||||
i = policies.iterator();
|
i = policies.iterator();
|
||||||
|
|
||||||
if (!i.hasNext())
|
if (!i.hasNext())
|
||||||
@@ -2256,7 +2256,6 @@ public class Item extends DSpaceObject
|
|||||||
/**
|
/**
|
||||||
* Check the bundle ORIGINAL to see if there are any uploaded files
|
* Check the bundle ORIGINAL to see if there are any uploaded files
|
||||||
*
|
*
|
||||||
* @param item
|
|
||||||
* @return true if there is a bundle named ORIGINAL with one or more
|
* @return true if there is a bundle named ORIGINAL with one or more
|
||||||
* bitstreams inside
|
* bitstreams inside
|
||||||
* @throws SQLException
|
* @throws SQLException
|
||||||
@@ -2364,9 +2363,9 @@ public class Item extends DSpaceObject
|
|||||||
* those matching the passed value, if value is not Item.ANY
|
* those matching the passed value, if value is not Item.ANY
|
||||||
*
|
*
|
||||||
* @param context DSpace context object
|
* @param context DSpace context object
|
||||||
* @param schema metdata field schema
|
* @param schema metadata field schema
|
||||||
* @param element metdata field element
|
* @param element metadata field element
|
||||||
* @param qualifier metdata field qualifier
|
* @param qualifier metadata field qualifier
|
||||||
* @param value field value or Item.ANY to match any value
|
* @param value field value or Item.ANY to match any value
|
||||||
* @return an iterator over the items matching that authority value
|
* @return an iterator over the items matching that authority value
|
||||||
* @throws SQLException, AuthorizeException, IOException
|
* @throws SQLException, AuthorizeException, IOException
|
||||||
@@ -2432,7 +2431,7 @@ public class Item extends DSpaceObject
|
|||||||
switch (action)
|
switch (action)
|
||||||
{
|
{
|
||||||
case Constants.ADD:
|
case Constants.ADD:
|
||||||
// ADD a cc license is less general then add a bitstream but we can't/wan't
|
// ADD a cc license is less general than add a bitstream but we can't/won't
|
||||||
// add complex logic here to know if the ADD action on the item is required by a cc or
|
// add complex logic here to know if the ADD action on the item is required by a cc or
|
||||||
// a generic bitstream so simply we ignore it.. UI need to enforce the requirements.
|
// a generic bitstream so simply we ignore it.. UI need to enforce the requirements.
|
||||||
if (AuthorizeConfiguration.canItemAdminPerformBitstreamCreation())
|
if (AuthorizeConfiguration.canItemAdminPerformBitstreamCreation())
|
||||||
@@ -2540,9 +2539,9 @@ public class Item extends DSpaceObject
|
|||||||
* in the indicated metadata field.
|
* in the indicated metadata field.
|
||||||
*
|
*
|
||||||
* @param context DSpace context object
|
* @param context DSpace context object
|
||||||
* @param schema metdata field schema
|
* @param schema metadata field schema
|
||||||
* @param element metdata field element
|
* @param element metadata field element
|
||||||
* @param qualifier metdata field qualifier
|
* @param qualifier metadata field qualifier
|
||||||
* @param value the value of authority key to look for
|
* @param value the value of authority key to look for
|
||||||
* @return an iterator over the items matching that authority value
|
* @return an iterator over the items matching that authority value
|
||||||
* @throws SQLException, AuthorizeException, IOException
|
* @throws SQLException, AuthorizeException, IOException
|
||||||
|
@@ -62,7 +62,8 @@ import org.dspace.storage.rdbms.TableRowIterator;
|
|||||||
*
|
*
|
||||||
* @author Martin Hald
|
* @author Martin Hald
|
||||||
* @version $Revision$
|
* @version $Revision$
|
||||||
* @see org.dspace.content.MetadataValue, org.dspace.content.MetadataSchema
|
* @see org.dspace.content.MetadataValue
|
||||||
|
* @see org.dspace.content.MetadataSchema
|
||||||
*/
|
*/
|
||||||
public class MetadataField
|
public class MetadataField
|
||||||
{
|
{
|
||||||
@@ -100,7 +101,7 @@ public class MetadataField
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Full contructor for new metadata field elements.
|
* Full constructor for new metadata field elements.
|
||||||
*
|
*
|
||||||
* @param schema schema to which the field belongs
|
* @param schema schema to which the field belongs
|
||||||
* @param element element of the field
|
* @param element element of the field
|
||||||
@@ -117,10 +118,10 @@ public class MetadataField
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Full construtor for existing metadata field elements.
|
* Full constructor for existing metadata field elements.
|
||||||
*
|
*
|
||||||
* @param schemaID schema to which the field belongs
|
* @param schemaID schema to which the field belongs
|
||||||
* @param fieldID dataabse ID of field.
|
* @param fieldID database ID of field.
|
||||||
* @param element element of the field
|
* @param element element of the field
|
||||||
* @param qualifier qualifier of the field
|
* @param qualifier qualifier of the field
|
||||||
* @param scopeNote scope note of the field
|
* @param scopeNote scope note of the field
|
||||||
|
@@ -65,7 +65,8 @@ import org.dspace.storage.rdbms.TableRowIterator;
|
|||||||
*
|
*
|
||||||
* @author Martin Hald
|
* @author Martin Hald
|
||||||
* @version $Revision$
|
* @version $Revision$
|
||||||
* @see org.dspace.content.MetadataValue, org.dspace.content.MetadataField
|
* @see org.dspace.content.MetadataValue
|
||||||
|
* @see org.dspace.content.MetadataField
|
||||||
*/
|
*/
|
||||||
public class MetadataSchema
|
public class MetadataSchema
|
||||||
{
|
{
|
||||||
|
@@ -53,11 +53,12 @@ import org.dspace.storage.rdbms.TableRowIterator;
|
|||||||
* Database access class representing a Dublin Core metadata value.
|
* Database access class representing a Dublin Core metadata value.
|
||||||
* It represents a value of a given <code>MetadataField</code> on an Item.
|
* It represents a value of a given <code>MetadataField</code> on an Item.
|
||||||
* (The Item can have many values of the same field.) It contains element, qualifier, value and language.
|
* (The Item can have many values of the same field.) It contains element, qualifier, value and language.
|
||||||
* the field (which names the schema, element, and qualifer), language,
|
* the field (which names the schema, element, and qualifier), language,
|
||||||
* and a value.
|
* and a value.
|
||||||
*
|
*
|
||||||
* @author Martin Hald
|
* @author Martin Hald
|
||||||
* @see org.dspace.content.MetadataSchema, org.dspace.content.MetadataField
|
* @see org.dspace.content.MetadataSchema
|
||||||
|
* @see org.dspace.content.MetadataField
|
||||||
*/
|
*/
|
||||||
public class MetadataValue
|
public class MetadataValue
|
||||||
{
|
{
|
||||||
@@ -122,7 +123,7 @@ public class MetadataValue
|
|||||||
/**
|
/**
|
||||||
* Constructor to create a value for a given field.
|
* Constructor to create a value for a given field.
|
||||||
*
|
*
|
||||||
* @param field inital value for field
|
* @param field initial value for field
|
||||||
*/
|
*/
|
||||||
public MetadataValue(MetadataField field)
|
public MetadataValue(MetadataField field)
|
||||||
{
|
{
|
||||||
|
@@ -98,7 +98,7 @@ public class Site extends DSpaceObject
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Static method to return site Handle without creating a Site.
|
* Static method to return site Handle without creating a Site.
|
||||||
* @returns handle of the Site.
|
* @return handle of the Site.
|
||||||
*/
|
*/
|
||||||
public static String getSiteHandle()
|
public static String getSiteHandle()
|
||||||
{
|
{
|
||||||
@@ -112,7 +112,7 @@ public class Site extends DSpaceObject
|
|||||||
* Get Site object corresponding to db id (which is ignroed).
|
* Get Site object corresponding to db id (which is ignroed).
|
||||||
* @param context the context.
|
* @param context the context.
|
||||||
* @param id integer database id, ignored.
|
* @param id integer database id, ignored.
|
||||||
* @returns Site object.
|
* @return Site object.
|
||||||
*/
|
*/
|
||||||
public static DSpaceObject find(Context context, int id)
|
public static DSpaceObject find(Context context, int id)
|
||||||
throws SQLException
|
throws SQLException
|
||||||
|
@@ -42,12 +42,13 @@ package org.dspace.content.authority;
|
|||||||
* one metadata field.
|
* one metadata field.
|
||||||
*
|
*
|
||||||
* @author Larry Stone
|
* @author Larry Stone
|
||||||
* @see ChoiceAuthorityManager, MetadataAuthorityManager
|
* @see ChoiceAuthorityManager
|
||||||
|
* @see MetadataAuthorityManager
|
||||||
*/
|
*/
|
||||||
public interface ChoiceAuthority
|
public interface ChoiceAuthority
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Get all values from the authority that match the proferred value.
|
* Get all values from the authority that match the profferred value.
|
||||||
* Note that the offering was entered by the user and may contain
|
* Note that the offering was entered by the user and may contain
|
||||||
* mixed/incorrect case, whitespace, etc so the plugin should be careful
|
* mixed/incorrect case, whitespace, etc so the plugin should be careful
|
||||||
* to clean up user data before making comparisons.
|
* to clean up user data before making comparisons.
|
||||||
|
@@ -108,7 +108,7 @@ public class ChoiceAuthorityManager
|
|||||||
}
|
}
|
||||||
|
|
||||||
// XXX FIXME maybe add sanity check, call
|
// XXX FIXME maybe add sanity check, call
|
||||||
// MetadataField.findByElement to maek sure it's a real field.
|
// MetadataField.findByElement to make sure it's a real field.
|
||||||
|
|
||||||
ChoiceAuthority ma = (ChoiceAuthority)
|
ChoiceAuthority ma = (ChoiceAuthority)
|
||||||
PluginManager.getNamedPlugin(ChoiceAuthority.class, ConfigurationManager.getProperty(key));
|
PluginManager.getNamedPlugin(ChoiceAuthority.class, ConfigurationManager.getProperty(key));
|
||||||
@@ -181,11 +181,11 @@ public class ChoiceAuthorityManager
|
|||||||
* Wrapper that calls getMatches method of the plugin corresponding to
|
* Wrapper that calls getMatches method of the plugin corresponding to
|
||||||
* the metadata field defined by schema,element,qualifier.
|
* the metadata field defined by schema,element,qualifier.
|
||||||
*
|
*
|
||||||
* @see ChoiceAuthority.getMatches
|
* @see ChoiceAuthority#getMatches(String, int, int, int, String)
|
||||||
* @param schema schema of metadata field
|
* @param schema schema of metadata field
|
||||||
* @param element element of metadata field
|
* @param element element of metadata field
|
||||||
* @param qualifier qualifier of metadata field
|
* @param qualifier qualifier of metadata field
|
||||||
* @param text user's value to match
|
* @param query user's value to match
|
||||||
* @param collection database ID of Collection for context (owner of Item)
|
* @param collection database ID of Collection for context (owner of Item)
|
||||||
* @param start choice at which to start, 0 is first.
|
* @param start choice at which to start, 0 is first.
|
||||||
* @param limit maximum number of choices to return, 0 for no limit.
|
* @param limit maximum number of choices to return, 0 for no limit.
|
||||||
@@ -193,29 +193,33 @@ public class ChoiceAuthorityManager
|
|||||||
* @return a Choices object (never null).
|
* @return a Choices object (never null).
|
||||||
*/
|
*/
|
||||||
public Choices getMatches(String schema, String element, String qualifier,
|
public Choices getMatches(String schema, String element, String qualifier,
|
||||||
String query, int collection, int start, int limit, String locale)
|
String query, int collection, int start, int limit, String locale)
|
||||||
{
|
{
|
||||||
return getMatches(makeFieldKey(schema, element, qualifier), query, collection, start, limit, locale);
|
return getMatches(makeFieldKey(schema, element, qualifier), query,
|
||||||
|
collection, start, limit, locale);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Wrapper calls getMatches method of the plugin corresponding to
|
* Wrapper calls getMatches method of the plugin corresponding to
|
||||||
* the metadata field defined by single field key.
|
* the metadata field defined by single field key.
|
||||||
*
|
*
|
||||||
* @see ChoiceAuthority.getMatches
|
* @see ChoiceAuthority#getMatches(String, int, int, int, String)
|
||||||
* @param fieldKey single string identifying metadata field
|
* @param fieldKey single string identifying metadata field
|
||||||
* @param text user's value to match
|
* @param query user's value to match
|
||||||
* @param collection database ID of Collection for context (owner of Item)
|
* @param collection database ID of Collection for context (owner of Item)
|
||||||
* @param start choice at which to start, 0 is first.
|
* @param start choice at which to start, 0 is first.
|
||||||
* @param limit maximum number of choices to return, 0 for no limit.
|
* @param limit maximum number of choices to return, 0 for no limit.
|
||||||
* @param locale explicit localization key if available, or null
|
* @param locale explicit localization key if available, or null
|
||||||
* @return a Choices object (never null).
|
* @return a Choices object (never null).
|
||||||
*/
|
*/
|
||||||
public Choices getMatches(String fieldKey, String query, int collection, int start, int limit, String locale)
|
public Choices getMatches(String fieldKey, String query, int collection,
|
||||||
|
int start, int limit, String locale)
|
||||||
{
|
{
|
||||||
ChoiceAuthority ma = controller.get(fieldKey);
|
ChoiceAuthority ma = controller.get(fieldKey);
|
||||||
if (ma == null)
|
if (ma == null)
|
||||||
throw new IllegalArgumentException("No choices plugin was configured for field \""+fieldKey+"\".");
|
throw new IllegalArgumentException(
|
||||||
|
"No choices plugin was configured for field \"" + fieldKey
|
||||||
|
+ "\".");
|
||||||
return ma.getMatches(query, collection, start, limit, locale);
|
return ma.getMatches(query, collection, start, limit, locale);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -223,18 +227,21 @@ public class ChoiceAuthorityManager
|
|||||||
* Wrapper that calls getBestMatch method of the plugin corresponding to
|
* Wrapper that calls getBestMatch method of the plugin corresponding to
|
||||||
* the metadata field defined by single field key.
|
* the metadata field defined by single field key.
|
||||||
*
|
*
|
||||||
* @see ChoiceAuthority.getBestMatch
|
* @see ChoiceAuthority#getBestMatch(String, int, String)
|
||||||
* @param fieldKey single string identifying metadata field
|
* @param fieldKey single string identifying metadata field
|
||||||
* @param text user's value to match
|
* @param query user's value to match
|
||||||
* @param collection database ID of Collection for context (owner of Item)
|
* @param collection database ID of Collection for context (owner of Item)
|
||||||
* @param locale explicit localization key if available, or null
|
* @param locale explicit localization key if available, or null
|
||||||
* @return a Choices object (never null) with 1 or 0 values.
|
* @return a Choices object (never null) with 1 or 0 values.
|
||||||
*/
|
*/
|
||||||
public Choices getBestMatch(String fieldKey, String query, int collection, String locale)
|
public Choices getBestMatch(String fieldKey, String query, int collection,
|
||||||
|
String locale)
|
||||||
{
|
{
|
||||||
ChoiceAuthority ma = controller.get(fieldKey);
|
ChoiceAuthority ma = controller.get(fieldKey);
|
||||||
if (ma == null)
|
if (ma == null)
|
||||||
throw new IllegalArgumentException("No choices plugin was configured for field \""+fieldKey+"\".");
|
throw new IllegalArgumentException(
|
||||||
|
"No choices plugin was configured for field \"" + fieldKey
|
||||||
|
+ "\".");
|
||||||
return ma.getBestMatch(query, collection, locale);
|
return ma.getBestMatch(query, collection, locale);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -75,7 +75,7 @@ import org.apache.commons.httpclient.HttpException;
|
|||||||
* Choice Authority based on SHERPA/RoMEO - for Publishers and Journals
|
* Choice Authority based on SHERPA/RoMEO - for Publishers and Journals
|
||||||
* See the subclasses SHERPARoMEOPublisher and SHERPARoMEOJournalTitle
|
* See the subclasses SHERPARoMEOPublisher and SHERPARoMEOJournalTitle
|
||||||
* for actual choice plugin implementations. This is a superclass
|
* for actual choice plugin implementations. This is a superclass
|
||||||
* containing all the common prototcol logic.
|
* containing all the common protocol logic.
|
||||||
*
|
*
|
||||||
* Reads these DSpace Config properties:
|
* Reads these DSpace Config properties:
|
||||||
*
|
*
|
||||||
@@ -86,7 +86,8 @@ import org.apache.commons.httpclient.HttpException;
|
|||||||
* as a proof-of-concept. Any site that actually wants to use it will
|
* as a proof-of-concept. Any site that actually wants to use it will
|
||||||
* probably have to refine it (and give patches back to dspace.org).
|
* probably have to refine it (and give patches back to dspace.org).
|
||||||
*
|
*
|
||||||
* @see SHERPARoMEOPublisher, SHERPARoMEOJournalTitle
|
* @see SHERPARoMEOPublisher
|
||||||
|
* @see SHERPARoMEOJournalTitle
|
||||||
* @author Larry Stone
|
* @author Larry Stone
|
||||||
* @version $Revision $
|
* @version $Revision $
|
||||||
*/
|
*/
|
||||||
|
@@ -68,7 +68,8 @@ public interface StreamIngestionCrosswalk
|
|||||||
*
|
*
|
||||||
* @param context the DSpace context
|
* @param context the DSpace context
|
||||||
* @param dso the DSpace Object whose metadata is being ingested.
|
* @param dso the DSpace Object whose metadata is being ingested.
|
||||||
* @param out input stream containing the metadata.
|
* @param in input stream containing the metadata.
|
||||||
|
* @param MIMEType MIME type of the ???
|
||||||
*
|
*
|
||||||
* @throws CrosswalkInternalException (<code>CrosswalkException</code>) failure of the crosswalk itself.
|
* @throws CrosswalkInternalException (<code>CrosswalkException</code>) failure of the crosswalk itself.
|
||||||
* @throws CrosswalkObjectNotSupported (<code>CrosswalkException</code>) Cannot crosswalk this kind of DSpace object.
|
* @throws CrosswalkObjectNotSupported (<code>CrosswalkException</code>) Cannot crosswalk this kind of DSpace object.
|
||||||
|
@@ -158,7 +158,7 @@ public abstract class XSLTCrosswalk extends SelfNamedPlugin
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Initialize the Transformation stylesheet from configured stylesheet file.
|
* Initialize the Transformation stylesheet from configured stylesheet file.
|
||||||
* @param prefix the direction of xwalk, either "submission" or
|
* @param direction the direction of xwalk, either "submission" or
|
||||||
* "dissemination"
|
* "dissemination"
|
||||||
* @return transformer or null if there was error initializing.
|
* @return transformer or null if there was error initializing.
|
||||||
*/
|
*/
|
||||||
|
@@ -136,10 +136,10 @@ public class METSManifest
|
|||||||
*
|
*
|
||||||
* @param mdRef JDOM element of mdRef in the METS manifest.
|
* @param mdRef JDOM element of mdRef in the METS manifest.
|
||||||
* @return stream containing the metadata mentioned in mdRef.
|
* @return stream containing the metadata mentioned in mdRef.
|
||||||
* @throw MetadataValidationException if the mdRef is unacceptable or missing required information.
|
* @throws MetadataValidationException if the mdRef is unacceptable or missing required information.
|
||||||
* @throw IOException if it is returned by services called by this method.
|
* @throws IOException if it is returned by services called by this method.
|
||||||
* @throw SQLException if it is returned by services called by this method.
|
* @throws SQLException if it is returned by services called by this method.
|
||||||
* @throw AuthorizeException if it is returned by services called by this method.
|
* @throws AuthorizeException if it is returned by services called by this method.
|
||||||
*/
|
*/
|
||||||
public InputStream getInputStream(Element mdRef)
|
public InputStream getInputStream(Element mdRef)
|
||||||
throws MetadataValidationException, IOException, SQLException, AuthorizeException;
|
throws MetadataValidationException, IOException, SQLException, AuthorizeException;
|
||||||
@@ -181,7 +181,7 @@ public class METSManifest
|
|||||||
/** all mdRef elements in the manifest */
|
/** all mdRef elements in the manifest */
|
||||||
private List mdFiles = null;
|
private List mdFiles = null;
|
||||||
|
|
||||||
/** <file> elements in "original" filegroup (bundle) */
|
/** <file> elements in "original" file group (bundle) */
|
||||||
private List contentFiles = null;
|
private List contentFiles = null;
|
||||||
|
|
||||||
/** builder to use for mdRef streams, inherited from create() */
|
/** builder to use for mdRef streams, inherited from create() */
|
||||||
@@ -539,7 +539,7 @@ public class METSManifest
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Return contents of *md element as List of XML Element objects.
|
* Return contents of *md element as List of XML Element objects.
|
||||||
* Gets content, dereferecing mdRef if necessary, or decoding and parsing
|
* Gets content, dereferencing mdRef if necessary, or decoding and parsing
|
||||||
* a binData that contains XML.
|
* a binData that contains XML.
|
||||||
* @return contents of metadata section, or empty list if no XML content is available.
|
* @return contents of metadata section, or empty list if no XML content is available.
|
||||||
* @throws MetadataValidationException if METS is invalid, or there is an error parsing the XML.
|
* @throws MetadataValidationException if METS is invalid, or there is an error parsing the XML.
|
||||||
@@ -612,7 +612,7 @@ public class METSManifest
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Return contents of *md element as stream.
|
* Return contents of *md element as stream.
|
||||||
* Gets content, dereferecing mdRef if necessary, or decoding
|
* Gets content, dereferencing mdRef if necessary, or decoding
|
||||||
* a binData element if necessary.
|
* a binData element if necessary.
|
||||||
* @return Stream containing contents of metadata section. Never returns null.
|
* @return Stream containing contents of metadata section. Never returns null.
|
||||||
* @throws MetadataValidationException if METS format does not contain any metadata.
|
* @throws MetadataValidationException if METS format does not contain any metadata.
|
||||||
@@ -802,9 +802,10 @@ public class METSManifest
|
|||||||
* Crosswalk the metadata associated with a particular <code>file</code>
|
* Crosswalk the metadata associated with a particular <code>file</code>
|
||||||
* element into the bitstream it corresponds to.
|
* element into the bitstream it corresponds to.
|
||||||
* @param context a dspace context.
|
* @param context a dspace context.
|
||||||
* @param bs bitstream target of the crosswalk
|
* @param bitstream bitstream target of the crosswalk
|
||||||
* @param fileId value of ID attribute in the file element responsible
|
* @param fileId value of ID attribute in the file element responsible
|
||||||
* for the contents of that bitstream.
|
* for the contents of that bitstream.
|
||||||
|
* @param callback ???
|
||||||
*/
|
*/
|
||||||
public void crosswalkBitstream(Context context, Bitstream bitstream,
|
public void crosswalkBitstream(Context context, Bitstream bitstream,
|
||||||
String fileId, Mdref callback)
|
String fileId, Mdref callback)
|
||||||
|
@@ -55,19 +55,26 @@ import org.apache.log4j.Logger;
|
|||||||
public class PackageException extends Exception
|
public class PackageException extends Exception
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Create a new exception with the given message.
|
* Create a new exception with no message.
|
||||||
* @param s - diagnostic message.
|
|
||||||
*/
|
*/
|
||||||
public PackageException()
|
public PackageException()
|
||||||
{
|
{
|
||||||
super();
|
super();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new exception with the given message.
|
||||||
|
* @param message - message text.
|
||||||
|
*/
|
||||||
public PackageException(String message)
|
public PackageException(String message)
|
||||||
{
|
{
|
||||||
super(message);
|
super(message);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new exception wrapping the given underlying cause.
|
||||||
|
* @param cause - exception specifying the cause of this failure.
|
||||||
|
*/
|
||||||
public PackageException(Throwable cause)
|
public PackageException(Throwable cause)
|
||||||
{
|
{
|
||||||
super(cause);
|
super(cause);
|
||||||
@@ -75,7 +82,8 @@ public class PackageException extends Exception
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new exception wrapping it around another exception.
|
* Create a new exception wrapping it around another exception.
|
||||||
* @param e - exception specifying the cause of this failure.
|
* @param message - message text.
|
||||||
|
* @param cause - exception specifying the cause of this failure.
|
||||||
*/
|
*/
|
||||||
public PackageException(String message, Throwable cause)
|
public PackageException(String message, Throwable cause)
|
||||||
{
|
{
|
||||||
|
@@ -146,7 +146,7 @@ public class PackageParameters extends Properties
|
|||||||
/**
|
/**
|
||||||
* Returns boolean form of property with selectable default
|
* Returns boolean form of property with selectable default
|
||||||
* @param key the key to look for in this property list.
|
* @param key the key to look for in this property list.
|
||||||
* @param default default to return if there is no such property
|
* @param defaultAnswer default to return if there is no such property
|
||||||
* @return the boolean derived from the value of property, or default
|
* @return the boolean derived from the value of property, or default
|
||||||
* if it was not specified.
|
* if it was not specified.
|
||||||
*/
|
*/
|
||||||
|
@@ -188,7 +188,7 @@ public class PackageUtils
|
|||||||
/**
|
/**
|
||||||
* Predicate, does this bundle container meta-information. I.e.
|
* Predicate, does this bundle container meta-information. I.e.
|
||||||
* does this bundle contain descriptive metadata or other metadata
|
* does this bundle contain descriptive metadata or other metadata
|
||||||
* such as license bitstreams? If so we probablly don't want to put
|
* such as license bitstreams? If so we probably don't want to put
|
||||||
* it into the "content" section of a package; hence this predicate.
|
* it into the "content" section of a package; hence this predicate.
|
||||||
*
|
*
|
||||||
* @param bn -- the bundle
|
* @param bn -- the bundle
|
||||||
@@ -239,7 +239,7 @@ public class PackageUtils
|
|||||||
* generic like ".xml", to accidentally get set to this format.
|
* generic like ".xml", to accidentally get set to this format.
|
||||||
* @param context - the context.
|
* @param context - the context.
|
||||||
* @param shortDesc - short descriptive name, used to locate existing format.
|
* @param shortDesc - short descriptive name, used to locate existing format.
|
||||||
* @param MIMEtype - mime content-type
|
* @param MIMEType - MIME content-type
|
||||||
* @param desc - long description
|
* @param desc - long description
|
||||||
* @return BitstreamFormat object that was found or created. Never null.
|
* @return BitstreamFormat object that was found or created. Never null.
|
||||||
*/
|
*/
|
||||||
|
@@ -56,7 +56,7 @@ public class PackageValidationException extends PackageException
|
|||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Create a new exception with the given message.
|
* Create a new exception with the given message.
|
||||||
* @param s - diagnostic message.
|
* @param message - diagnostic message.
|
||||||
*/
|
*/
|
||||||
public PackageValidationException(String message)
|
public PackageValidationException(String message)
|
||||||
{
|
{
|
||||||
@@ -65,7 +65,7 @@ public class PackageValidationException extends PackageException
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new exception wrapping it around another exception.
|
* Create a new exception wrapping it around another exception.
|
||||||
* @param e - exception specifying the cause of this failure.
|
* @param exception - exception specifying the cause of this failure.
|
||||||
*/
|
*/
|
||||||
public PackageValidationException(Exception exception)
|
public PackageValidationException(Exception exception)
|
||||||
{
|
{
|
||||||
|
@@ -31,7 +31,7 @@ There is also a 'replace' method, but this is not implemented consistently.
|
|||||||
<p>Ingester and disseminator implementations exist for METs and PDF packages, and the
|
<p>Ingester and disseminator implementations exist for METs and PDF packages, and the
|
||||||
classes are designed to be extended for different profiles.<p>
|
classes are designed to be extended for different profiles.<p>
|
||||||
|
|
||||||
@see org.dspace.content.packager.AbstractMETSIngester<br>
|
@see org.dspace.content.packager.AbstractMETSIngester
|
||||||
@see org.dspace.content.packager.AbstractMETSDisseminator
|
@see org.dspace.content.packager.AbstractMETSDisseminator
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
|
@@ -253,9 +253,9 @@ public class ConfigurationManager
|
|||||||
* Get the License
|
* Get the License
|
||||||
*
|
*
|
||||||
* @param
|
* @param
|
||||||
* license file name
|
* licenseFile file name
|
||||||
*
|
*
|
||||||
* @return
|
* @return
|
||||||
* license text
|
* license text
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@@ -469,9 +469,8 @@ public class ConfigurationManager
|
|||||||
/**
|
/**
|
||||||
* Reads news from a text file.
|
* Reads news from a text file.
|
||||||
*
|
*
|
||||||
* @param position
|
* @param newsFile
|
||||||
* a constant indicating which file (top or side) should be read
|
* name of the news file to read in, relative to the news file path.
|
||||||
* in.
|
|
||||||
*/
|
*/
|
||||||
public static String readNewsFile(String newsFile)
|
public static String readNewsFile(String newsFile)
|
||||||
{
|
{
|
||||||
@@ -508,9 +507,8 @@ public class ConfigurationManager
|
|||||||
/**
|
/**
|
||||||
* Writes news to a text file.
|
* Writes news to a text file.
|
||||||
*
|
*
|
||||||
* @param position
|
* @param newsFile
|
||||||
* a constant indicating which file (top or side) should be
|
* name of the news file to write, relative to the news file path.
|
||||||
* written to.
|
|
||||||
*
|
*
|
||||||
* @param news
|
* @param news
|
||||||
* the text to be written to the file.
|
* the text to be written to the file.
|
||||||
@@ -541,7 +539,10 @@ public class ConfigurationManager
|
|||||||
/**
|
/**
|
||||||
* Writes license to a text file.
|
* Writes license to a text file.
|
||||||
*
|
*
|
||||||
* @param news
|
* @param licenseFile
|
||||||
|
* name for the file into which the license will be written,
|
||||||
|
* relative to the current directory.
|
||||||
|
* @param newLicense
|
||||||
* the text to be written to the file.
|
* the text to be written to the file.
|
||||||
*/
|
*/
|
||||||
public static void writeLicenseFile(String licenseFile, String newLicense)
|
public static void writeLicenseFile(String licenseFile, String newLicense)
|
||||||
|
@@ -92,11 +92,11 @@ public class Context
|
|||||||
/** Indicates whether authorisation subsystem should be ignored */
|
/** Indicates whether authorisation subsystem should be ignored */
|
||||||
private boolean ignoreAuth;
|
private boolean ignoreAuth;
|
||||||
|
|
||||||
/** A stack with the history of authoritation system check modify */
|
/** A stack with the history of authorisation system check modify */
|
||||||
private Stack<Boolean> authStateChangeHistory;
|
private Stack<Boolean> authStateChangeHistory;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A stack with the name of the caller class that modify authoritation
|
* A stack with the name of the caller class that modify authorisation
|
||||||
* system check
|
* system check
|
||||||
*/
|
*/
|
||||||
private Stack<String> authStateClassCallHistory;
|
private Stack<String> authStateClassCallHistory;
|
||||||
@@ -185,7 +185,7 @@ public class Context
|
|||||||
/**
|
/**
|
||||||
* set the current Locale
|
* set the current Locale
|
||||||
*
|
*
|
||||||
* @param Locale
|
* @param locale
|
||||||
* the current Locale
|
* the current Locale
|
||||||
*/
|
*/
|
||||||
public void setCurrentLocale(Locale locale)
|
public void setCurrentLocale(Locale locale)
|
||||||
@@ -314,7 +314,7 @@ public class Context
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Close the context object after all of the operations performed in the
|
* Close the context object after all of the operations performed in the
|
||||||
* context have completed succesfully. Any transaction with the database is
|
* context have completed successfully. Any transaction with the database is
|
||||||
* committed.
|
* committed.
|
||||||
*
|
*
|
||||||
* @exception SQLException
|
* @exception SQLException
|
||||||
|
@@ -312,12 +312,12 @@ public class I18nUtil
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the i18n message string for a given key and locale
|
* Get the i18n message string for a given key and context
|
||||||
*
|
*
|
||||||
* @param key
|
* @param key
|
||||||
* String - name of the key to get the message for
|
* String - name of the key to get the message for
|
||||||
* @param locale
|
* @param c
|
||||||
* Locale, to get the message for
|
* Context having the desired Locale
|
||||||
*
|
*
|
||||||
* @return message
|
* @return message
|
||||||
* String of the message
|
* String of the message
|
||||||
|
@@ -359,7 +359,7 @@ public class EPerson extends DSpaceObject
|
|||||||
* @param query
|
* @param query
|
||||||
* The search string
|
* The search string
|
||||||
*
|
*
|
||||||
* @return the number of epeople mathching the query
|
* @return the number of epeople matching the query
|
||||||
*/
|
*/
|
||||||
public static int searchResultCount(Context context, String query)
|
public static int searchResultCount(Context context, String query)
|
||||||
throws SQLException
|
throws SQLException
|
||||||
@@ -576,7 +576,7 @@ public class EPerson extends DSpaceObject
|
|||||||
* Locale specification of the form {language} or {language}_{territory},
|
* Locale specification of the form {language} or {language}_{territory},
|
||||||
* e.g. "en", "en_US", "pt_BR" (the latter is Brazilian Portugese).
|
* e.g. "en", "en_US", "pt_BR" (the latter is Brazilian Portugese).
|
||||||
*
|
*
|
||||||
* @param s
|
* @param language
|
||||||
* language
|
* language
|
||||||
*/
|
*/
|
||||||
public void setLanguage(String language)
|
public void setLanguage(String language)
|
||||||
|
@@ -82,7 +82,7 @@ public class ConsumerProfile
|
|||||||
*
|
*
|
||||||
* @param name
|
* @param name
|
||||||
* configuration name of the consumer profile
|
* configuration name of the consumer profile
|
||||||
* @returns a new ConsumerProfile; never null.
|
* @return a new ConsumerProfile; never null.
|
||||||
*/
|
*/
|
||||||
public static ConsumerProfile makeConsumerProfile(String name)
|
public static ConsumerProfile makeConsumerProfile(String name)
|
||||||
throws IllegalArgumentException, ClassNotFoundException,
|
throws IllegalArgumentException, ClassNotFoundException,
|
||||||
|
@@ -57,7 +57,7 @@ public abstract class Dispatcher
|
|||||||
{
|
{
|
||||||
protected String name;
|
protected String name;
|
||||||
|
|
||||||
/** unique identifer of this dispatcher - cached hash of its text Name */
|
/** unique identifier of this dispatcher - cached hash of its text Name */
|
||||||
protected int identifier;
|
protected int identifier;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -78,7 +78,7 @@ public abstract class Dispatcher
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns unique integer that identifies this Dispatcher configuration.
|
* @return unique integer that identifies this Dispatcher configuration.
|
||||||
*/
|
*/
|
||||||
public int getIdentifier()
|
public int getIdentifier()
|
||||||
{
|
{
|
||||||
@@ -86,12 +86,10 @@ public abstract class Dispatcher
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add a consumer to the end of the list.
|
* Add a consumer profile to the end of the list.
|
||||||
*
|
*
|
||||||
* @param consumer
|
* @param cp
|
||||||
* the event consumer to add
|
* the event consumer profile to add
|
||||||
* @param filter
|
|
||||||
* the event filter to apply
|
|
||||||
*/
|
*/
|
||||||
public abstract void addConsumerProfile(ConsumerProfile cp)
|
public abstract void addConsumerProfile(ConsumerProfile cp)
|
||||||
throws IllegalArgumentException;
|
throws IllegalArgumentException;
|
||||||
|
@@ -252,7 +252,6 @@ public class Event implements Serializable
|
|||||||
* database ID of object instance.
|
* database ID of object instance.
|
||||||
* @param detail
|
* @param detail
|
||||||
* detail information that depends on context.
|
* detail information that depends on context.
|
||||||
* @param
|
|
||||||
*/
|
*/
|
||||||
public Event(int eventType, int subjectType, int subjectID, int objectType,
|
public Event(int eventType, int subjectType, int subjectID, int objectType,
|
||||||
int objectID, String detail)
|
int objectID, String detail)
|
||||||
@@ -272,7 +271,7 @@ public class Event implements Serializable
|
|||||||
*
|
*
|
||||||
* @param other
|
* @param other
|
||||||
* the event to compare this one to
|
* the event to compare this one to
|
||||||
* @returns true if events are "equal", false otherwise.
|
* @return true if events are "equal", false otherwise.
|
||||||
*/
|
*/
|
||||||
public boolean equals(Event other)
|
public boolean equals(Event other)
|
||||||
{
|
{
|
||||||
@@ -319,7 +318,7 @@ public class Event implements Serializable
|
|||||||
/**
|
/**
|
||||||
* Get the DSpace object which is the "object" of an event.
|
* Get the DSpace object which is the "object" of an event.
|
||||||
*
|
*
|
||||||
* @returns DSpaceObject or null if none can be found or no object was set.
|
* @return DSpaceObject or null if none can be found or no object was set.
|
||||||
*/
|
*/
|
||||||
public DSpaceObject getObject(Context context) throws SQLException
|
public DSpaceObject getObject(Context context) throws SQLException
|
||||||
{
|
{
|
||||||
@@ -335,7 +334,7 @@ public class Event implements Serializable
|
|||||||
* Syntactic sugar to get the DSpace object which is the "subject" of an
|
* Syntactic sugar to get the DSpace object which is the "subject" of an
|
||||||
* event.
|
* event.
|
||||||
*
|
*
|
||||||
* @returns DSpaceObject or null if none can be found.
|
* @return DSpaceObject or null if none can be found.
|
||||||
*/
|
*/
|
||||||
public DSpaceObject getSubject(Context context) throws SQLException
|
public DSpaceObject getSubject(Context context) throws SQLException
|
||||||
{
|
{
|
||||||
@@ -343,7 +342,7 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns database ID of subject of this event.
|
* @return database ID of subject of this event.
|
||||||
*/
|
*/
|
||||||
public int getSubjectID()
|
public int getSubjectID()
|
||||||
{
|
{
|
||||||
@@ -351,7 +350,7 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns database ID of object of this event, or -1 if none was set.
|
* @return database ID of object of this event, or -1 if none was set.
|
||||||
*/
|
*/
|
||||||
public int getObjectID()
|
public int getObjectID()
|
||||||
{
|
{
|
||||||
@@ -359,7 +358,7 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns type number (e.g. Constants.ITEM) of subject of this event.
|
* @return type number (e.g. Constants.ITEM) of subject of this event.
|
||||||
*/
|
*/
|
||||||
public int getSubjectType()
|
public int getSubjectType()
|
||||||
{
|
{
|
||||||
@@ -367,7 +366,7 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns type number (e.g. Constants.ITEM) of object of this event, or -1
|
* @return type number (e.g. Constants.ITEM) of object of this event, or -1
|
||||||
* if none was set.
|
* if none was set.
|
||||||
*/
|
*/
|
||||||
public int getObjectType()
|
public int getObjectType()
|
||||||
@@ -376,7 +375,7 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns type of subject of this event as a String, e.g. for logging.
|
* @return type of subject of this event as a String, e.g. for logging.
|
||||||
*/
|
*/
|
||||||
public String getSubjectTypeAsString()
|
public String getSubjectTypeAsString()
|
||||||
{
|
{
|
||||||
@@ -388,7 +387,7 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns type of object of this event as a String, e.g. for logging.
|
* @return type of object of this event as a String, e.g. for logging.
|
||||||
*/
|
*/
|
||||||
public String getObjectTypeAsString()
|
public String getObjectTypeAsString()
|
||||||
{
|
{
|
||||||
@@ -406,7 +405,7 @@ public class Event implements Serializable
|
|||||||
*
|
*
|
||||||
* @param s
|
* @param s
|
||||||
* text name of object type.
|
* text name of object type.
|
||||||
* @returns numeric value of object type or 0 for error.
|
* @return numeric value of object type or 0 for error.
|
||||||
*/
|
*/
|
||||||
public static int parseObjectType(String s)
|
public static int parseObjectType(String s)
|
||||||
{
|
{
|
||||||
@@ -422,7 +421,7 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns event-type (i.e. action) this event, one of the masks like
|
* @return event-type (i.e. action) this event, one of the masks like
|
||||||
* Event.ADD defined above.
|
* Event.ADD defined above.
|
||||||
*/
|
*/
|
||||||
public int getEventType()
|
public int getEventType()
|
||||||
@@ -433,7 +432,7 @@ public class Event implements Serializable
|
|||||||
/**
|
/**
|
||||||
* Get the text name of event (action) type.
|
* Get the text name of event (action) type.
|
||||||
*
|
*
|
||||||
* @returns event-type (i.e. action) this event as a String, e.g. for
|
* @return event-type (i.e. action) this event as a String, e.g. for
|
||||||
* logging.
|
* logging.
|
||||||
*/
|
*/
|
||||||
public String getEventTypeAsString()
|
public String getEventTypeAsString()
|
||||||
@@ -448,9 +447,9 @@ public class Event implements Serializable
|
|||||||
/**
|
/**
|
||||||
* Interpret named event type.
|
* Interpret named event type.
|
||||||
*
|
*
|
||||||
* @param text
|
* @param s
|
||||||
* name of event type.
|
* name of event type.
|
||||||
* @returns numeric value of event type or 0 for error.
|
* @return numeric value of event type or 0 for error.
|
||||||
*/
|
*/
|
||||||
public static int parseEventType(String s)
|
public static int parseEventType(String s)
|
||||||
{
|
{
|
||||||
@@ -469,8 +468,8 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns timestamp at which event occurred, as a count of milliseconds
|
* @return timestamp at which event occurred, as a count of milliseconds
|
||||||
* since the epoch (standard Java format).
|
* since the epoch (standard Java format).
|
||||||
*/
|
*/
|
||||||
public long getTimeStamp()
|
public long getTimeStamp()
|
||||||
{
|
{
|
||||||
@@ -478,8 +477,8 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns hashcode identifier of name of Dispatcher which first dispatched
|
* @return hashcode identifier of name of Dispatcher which first dispatched
|
||||||
* this event. (Needed by asynch dispatch code.)
|
* this event. (Needed by asynch dispatch code.)
|
||||||
*/
|
*/
|
||||||
public int getDispatcher()
|
public int getDispatcher()
|
||||||
{
|
{
|
||||||
@@ -487,7 +486,7 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns value of detail element of the event.
|
* @return value of detail element of the event.
|
||||||
*/
|
*/
|
||||||
public String getDetail()
|
public String getDetail()
|
||||||
{
|
{
|
||||||
@@ -495,7 +494,7 @@ public class Event implements Serializable
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns value of transactionID element of the event.
|
* @return value of transactionID element of the event.
|
||||||
*/
|
*/
|
||||||
public String getTransactionID()
|
public String getTransactionID()
|
||||||
{
|
{
|
||||||
@@ -538,8 +537,8 @@ public class Event implements Serializable
|
|||||||
*
|
*
|
||||||
* @param filters
|
* @param filters
|
||||||
* list of filter masks; each one is an Array of two ints.
|
* list of filter masks; each one is an Array of two ints.
|
||||||
* @returns true if this event would be passed through the given filter
|
* @return true if this event would be passed through the given filter
|
||||||
* list.
|
* list.
|
||||||
*/
|
*/
|
||||||
public boolean pass(List filters)
|
public boolean pass(List filters)
|
||||||
{
|
{
|
||||||
@@ -585,13 +584,16 @@ public class Event implements Serializable
|
|||||||
consumedBy.set(EventManager.getConsumerIndex(consumerName));
|
consumedBy.set(EventManager.getConsumerIndex(consumerName));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return the set of consumers which have consumed this Event.
|
||||||
|
*/
|
||||||
public BitSet getBitSet()
|
public BitSet getBitSet()
|
||||||
{
|
{
|
||||||
return consumedBy;
|
return consumedBy;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns Detailed string representation of contents of this event, to
|
* @return Detailed string representation of contents of this event, to
|
||||||
* help in logging and debugging.
|
* help in logging and debugging.
|
||||||
*/
|
*/
|
||||||
public String toString()
|
public String toString()
|
||||||
|
@@ -241,7 +241,7 @@ public class HarvestedCollection
|
|||||||
/**
|
/**
|
||||||
* Find all collections with the specified status flag
|
* Find all collections with the specified status flag
|
||||||
* @param c
|
* @param c
|
||||||
* @param status, see HarvestInstance.STATUS_...
|
* @param status see HarvestInstance.STATUS_...
|
||||||
* @return
|
* @return
|
||||||
* @throws SQLException
|
* @throws SQLException
|
||||||
*/
|
*/
|
||||||
@@ -309,7 +309,7 @@ public class HarvestedCollection
|
|||||||
setHarvestMetadataConfig(mdConfigId);
|
setHarvestMetadataConfig(mdConfigId);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Setters for the appropriate harverting-related columns */
|
/* Setters for the appropriate harvesting-related columns */
|
||||||
public void setHarvestType(int type) {
|
public void setHarvestType(int type) {
|
||||||
harvestRow.setColumn("harvest_type",type);
|
harvestRow.setColumn("harvest_type",type);
|
||||||
modified = true;
|
modified = true;
|
||||||
@@ -389,7 +389,7 @@ public class HarvestedCollection
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/* Getting for the appropriate harverting-related columns */
|
/* Getting for the appropriate harvesting-related columns */
|
||||||
public int getCollectionId() {
|
public int getCollectionId() {
|
||||||
return harvestRow.getIntColumn("collection_id");
|
return harvestRow.getIntColumn("collection_id");
|
||||||
}
|
}
|
||||||
|
@@ -45,23 +45,24 @@ import org.dspace.content.Collection;
|
|||||||
import org.dspace.core.Context;
|
import org.dspace.core.Context;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Interface that must be implemented by any plugin wanting to be called at
|
* Interface that must be implemented by any plugin wanting to be called at the
|
||||||
* the inception of the Community home page (in HandleServlet). Classes that implement the process method
|
* inception of the Collection home page (in HandleServlet). Classes that
|
||||||
* and appear in the configuration will be run before the at the start of preparing the community home page has any
|
* implement the process method and appear in the configuration will be run
|
||||||
* chance to continue its execution
|
* before the at the start of preparing the collection home page has any chance
|
||||||
|
* to continue its execution
|
||||||
*
|
*
|
||||||
* @author Richard Jones
|
* @author Richard Jones
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
public interface CollectionHomeProcessor
|
public interface CollectionHomeProcessor
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* execute the process
|
* execute the process
|
||||||
*
|
*
|
||||||
* @param context the DSpace context
|
* @param context the DSpace context
|
||||||
* @param request the HTTP request
|
* @param request the HTTP request
|
||||||
* @param response the HTTP response
|
* @param response the HTTP response
|
||||||
* @param community The community object whose home page we are on
|
* @param collection the collection object whose home page we are on
|
||||||
*
|
*
|
||||||
* @throws PluginException any particular problem with the plugin execution
|
* @throws PluginException any particular problem with the plugin execution
|
||||||
* @throws AuthorizeException Authorisation errors during plugin execution
|
* @throws AuthorizeException Authorisation errors during plugin execution
|
||||||
|
@@ -551,7 +551,7 @@ public class TableRow
|
|||||||
*
|
*
|
||||||
* @param column
|
* @param column
|
||||||
* The column name (case-insensitive)
|
* The column name (case-insensitive)
|
||||||
* @param l
|
* @param d
|
||||||
* The double value
|
* The double value
|
||||||
*/
|
*/
|
||||||
public void setColumn(String column, double d)
|
public void setColumn(String column, double d)
|
||||||
@@ -604,7 +604,7 @@ public class TableRow
|
|||||||
/**
|
/**
|
||||||
* Return a String representation of this object.
|
* Return a String representation of this object.
|
||||||
*
|
*
|
||||||
* @return String representaton
|
* @return String representation
|
||||||
*/
|
*/
|
||||||
public String toString()
|
public String toString()
|
||||||
{
|
{
|
||||||
|
@@ -174,7 +174,7 @@ public abstract class AbstractProcessingStep
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets th list of all UI fields which had errors that occurred during the
|
* Sets the list of all UI fields which had errors that occurred during the
|
||||||
* step processing. This list is for usage in generating the appropriate
|
* step processing. This list is for usage in generating the appropriate
|
||||||
* error message(s) in the UI.
|
* error message(s) in the UI.
|
||||||
* <P>
|
* <P>
|
||||||
@@ -272,8 +272,10 @@ public abstract class AbstractProcessingStep
|
|||||||
* This is extremely useful to define the error message which will be logged
|
* This is extremely useful to define the error message which will be logged
|
||||||
* for a non-interactive step.
|
* for a non-interactive step.
|
||||||
*
|
*
|
||||||
* @param fieldName
|
* @param errorFlag
|
||||||
* the name of the field which had an error
|
* the status value indicating the type of error
|
||||||
|
* @param errorMessage
|
||||||
|
* text of the message to be added
|
||||||
*/
|
*/
|
||||||
protected final void addErrorMessage(int errorFlag, String errorMessage)
|
protected final void addErrorMessage(int errorFlag, String errorMessage)
|
||||||
{
|
{
|
||||||
|
@@ -103,7 +103,7 @@ public class SelectGroupTag extends TagSupport
|
|||||||
/**
|
/**
|
||||||
* Setter for groups in list
|
* Setter for groups in list
|
||||||
*
|
*
|
||||||
* @param e attribute from JSP
|
* @param g attribute from JSP
|
||||||
*/
|
*/
|
||||||
public void setSelected(Object g)
|
public void setSelected(Object g)
|
||||||
{
|
{
|
||||||
|
@@ -656,8 +656,8 @@ public class JSPStepManager
|
|||||||
* @param request
|
* @param request
|
||||||
* current servlet request object
|
* current servlet request object
|
||||||
*
|
*
|
||||||
* @returns pathToJSP The context path to the JSP page (e.g.
|
* @return pathToJSP The context path to the JSP page (e.g.
|
||||||
* "/submit/select-collection.jsp")
|
* "/submit/select-collection.jsp")
|
||||||
*/
|
*/
|
||||||
public static final String getLastJSPDisplayed(HttpServletRequest request)
|
public static final String getLastJSPDisplayed(HttpServletRequest request)
|
||||||
{
|
{
|
||||||
|
@@ -43,7 +43,7 @@ import java.io.UnsupportedEncodingException;
|
|||||||
* <li>Add a {@link DatasetDSpaceObjectGenerator} for the appropriate object type.</li>
|
* <li>Add a {@link DatasetDSpaceObjectGenerator} for the appropriate object type.</li>
|
||||||
* <li>Add other generators as required to get the statistic you want.</li>
|
* <li>Add other generators as required to get the statistic you want.</li>
|
||||||
* <li>Add {@link org.dspace.statistics.content.filter filters} as required.</li>
|
* <li>Add {@link org.dspace.statistics.content.filter filters} as required.</li>
|
||||||
* <li>{@link createDataset} will run the query and return a result matrix.
|
* <li>{@link #createDataset(Context)} will run the query and return a result matrix.
|
||||||
* Subsequent calls skip the query and return the same matrix.</li>
|
* Subsequent calls skip the query and return the same matrix.</li>
|
||||||
* </ol>
|
* </ol>
|
||||||
*
|
*
|
||||||
|
@@ -25,14 +25,14 @@ public class StatisticsSolrDateFilter implements StatisticsFilter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** Set the start date as a string expression.
|
/** Set the start date as a string expression.
|
||||||
* Must be paired with {@link setEndStr()}.
|
* Must be paired with {@link #setEndStr(String)}.
|
||||||
*/
|
*/
|
||||||
public void setStartStr(String startStr) {
|
public void setStartStr(String startStr) {
|
||||||
this.startStr = startStr;
|
this.startStr = startStr;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Set the end date as a string expression.
|
/** Set the end date as a string expression.
|
||||||
* Must be paired with {@link setStartStr()}.
|
* Must be paired with {@link #setStartStr(String)}.
|
||||||
*/
|
*/
|
||||||
public void setEndStr(String endStr) {
|
public void setEndStr(String endStr) {
|
||||||
this.endStr = endStr;
|
this.endStr = endStr;
|
||||||
@@ -44,14 +44,14 @@ public class StatisticsSolrDateFilter implements StatisticsFilter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** Set the start date as a Date object.
|
/** Set the start date as a Date object.
|
||||||
* Must be paired with {@link setEndDate()}.
|
* Must be paired with {@link #setEndDate(Date)}.
|
||||||
*/
|
*/
|
||||||
public void setStartDate(Date startDate) {
|
public void setStartDate(Date startDate) {
|
||||||
this.startDate = startDate;
|
this.startDate = startDate;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Set the end date as a Date object.
|
/** Set the end date as a Date object.
|
||||||
* Must be paired with {@link setStartDate()}.
|
* Must be paired with {@link #setStartDate(Date)}.
|
||||||
*/
|
*/
|
||||||
public void setEndDate(Date endDate) {
|
public void setEndDate(Date endDate) {
|
||||||
this.endDate = endDate;
|
this.endDate = endDate;
|
||||||
|
@@ -127,7 +127,7 @@ public class Entry extends XmlElement implements SwordElementInterface
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* This is a simplified version. The ID can also have atomCommonAttributes,
|
* This is a simplified version. The ID can also have atomCommonAttributes,
|
||||||
* but these have not been modelled in this version. The content of
|
* but these have not been modeled in this version. The content of
|
||||||
* ID is an unconstrained string, which is intended to represent a URI.
|
* ID is an unconstrained string, which is intended to represent a URI.
|
||||||
*/
|
*/
|
||||||
private Id id;
|
private Id id;
|
||||||
@@ -198,7 +198,7 @@ public class Entry extends XmlElement implements SwordElementInterface
|
|||||||
* Create a new instance of the class an initalise it, setting the
|
* Create a new instance of the class an initalise it, setting the
|
||||||
* element namespace and name.
|
* element namespace and name.
|
||||||
*
|
*
|
||||||
* @param namespace The namespace of the element
|
* @param prefix The namespace prefix of the element
|
||||||
* @param element The element name
|
* @param element The element name
|
||||||
*/
|
*/
|
||||||
public Entry(String prefix, String element)
|
public Entry(String prefix, String element)
|
||||||
@@ -264,7 +264,7 @@ public class Entry extends XmlElement implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Mashall the data stored in this object into Element objects.
|
* Marshal the data stored in this object into Element objects.
|
||||||
*
|
*
|
||||||
* @return An element that holds the data associated with this object.
|
* @return An element that holds the data associated with this object.
|
||||||
*/
|
*/
|
||||||
@@ -346,7 +346,7 @@ public class Entry extends XmlElement implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Unmarshall the contents of the Entry element into the internal data objects
|
* Unmarshal the contents of the Entry element into the internal data objects
|
||||||
* in this object.
|
* in this object.
|
||||||
*
|
*
|
||||||
* @param entry The Entry element to process.
|
* @param entry The Entry element to process.
|
||||||
@@ -369,7 +369,7 @@ public class Entry extends XmlElement implements SwordElementInterface
|
|||||||
return handleIncorrectElement(entry, validationProperties);
|
return handleIncorrectElement(entry, validationProperties);
|
||||||
}
|
}
|
||||||
|
|
||||||
// used to hold the element and attribute unmarshall info results
|
// used to hold the element and attribute unmarshal info results
|
||||||
SwordValidationInfo result = new SwordValidationInfo(xmlName);
|
SwordValidationInfo result = new SwordValidationInfo(xmlName);
|
||||||
|
|
||||||
try
|
try
|
||||||
@@ -605,11 +605,12 @@ public class Entry extends XmlElement implements SwordElementInterface
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param elementsInfo
|
* @param info
|
||||||
* @param attributeInfo
|
* @param validationContext
|
||||||
* @return
|
* @return
|
||||||
*/
|
*/
|
||||||
protected SwordValidationInfo validate(SwordValidationInfo info, Properties validationContext)
|
protected SwordValidationInfo validate(SwordValidationInfo info,
|
||||||
|
Properties validationContext)
|
||||||
{
|
{
|
||||||
// determine if a full validation is required
|
// determine if a full validation is required
|
||||||
boolean validateAll = (info == null);
|
boolean validateAll = (info == null);
|
||||||
@@ -934,8 +935,6 @@ public class Entry extends XmlElement implements SwordElementInterface
|
|||||||
* is in the correct format.
|
* is in the correct format.
|
||||||
*
|
*
|
||||||
* @param published The string.
|
* @param published The string.
|
||||||
* @see org.purl.sword.base.XmlElement#stringToDate(String) stringToDate
|
|
||||||
* @see Entry#setPublished(Date) setPublished
|
|
||||||
*/
|
*/
|
||||||
public void setPublished(String published)
|
public void setPublished(String published)
|
||||||
{
|
{
|
||||||
@@ -962,7 +961,7 @@ public class Entry extends XmlElement implements SwordElementInterface
|
|||||||
/**
|
/**
|
||||||
* Get the source for this Entry.
|
* Get the source for this Entry.
|
||||||
* @return The source.
|
* @return The source.
|
||||||
* @Deprecated
|
* @deprecated
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
public Source getSource() {
|
public Source getSource() {
|
||||||
@@ -973,7 +972,7 @@ public class Entry extends XmlElement implements SwordElementInterface
|
|||||||
* Set the source for this entry.
|
* Set the source for this entry.
|
||||||
*
|
*
|
||||||
* @param source The source.
|
* @param source The source.
|
||||||
* @Deprecated
|
* @deprecated
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
public void setSource(Source source)
|
public void setSource(Source source)
|
||||||
@@ -1044,8 +1043,7 @@ public class Entry extends XmlElement implements SwordElementInterface
|
|||||||
* string.
|
* string.
|
||||||
*
|
*
|
||||||
* @param updated The string.
|
* @param updated The string.
|
||||||
* @see org.purl.sword.base.XmlElement#stringToDate(String) stringToDate
|
* @see Entry#setPublished(String) setPublished
|
||||||
* @see Entry#setPublished(Date) setPublished
|
|
||||||
*/
|
*/
|
||||||
public void setUpdated(String updated)
|
public void setUpdated(String updated)
|
||||||
{
|
{
|
||||||
|
@@ -59,7 +59,7 @@ import org.purl.sword.base.XmlName;
|
|||||||
public class Generator extends XmlElement implements SwordElementInterface
|
public class Generator extends XmlElement implements SwordElementInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Label for the uri attribute.
|
* Label for the URI attribute.
|
||||||
*/
|
*/
|
||||||
public static final String ATTRIBUTE_URI = "uri";
|
public static final String ATTRIBUTE_URI = "uri";
|
||||||
|
|
||||||
@@ -123,7 +123,7 @@ public class Generator extends XmlElement implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Marshall the data in the object to an Element object.
|
* Marshal the data in the object to an Element object.
|
||||||
*
|
*
|
||||||
* @return The element.
|
* @return The element.
|
||||||
*/
|
*/
|
||||||
@@ -153,7 +153,7 @@ public class Generator extends XmlElement implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Unmarshall the specified Generator element into the data in this object.
|
* Unmarshal the specified Generator element into the data in this object.
|
||||||
*
|
*
|
||||||
* @param generator The generator element.
|
* @param generator The generator element.
|
||||||
*
|
*
|
||||||
@@ -367,8 +367,6 @@ public class Generator extends XmlElement implements SwordElementInterface
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a string representation.
|
* Get a string representation.
|
||||||
*
|
|
||||||
* @param The string.
|
|
||||||
*/
|
*/
|
||||||
public String toString()
|
public String toString()
|
||||||
{
|
{
|
||||||
|
@@ -88,7 +88,7 @@ public class Source extends XmlElement implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Marshall the data stored in this object into Element objects.
|
* Marshal the data stored in this object into Element objects.
|
||||||
*
|
*
|
||||||
* @return An element that holds the data associated with this object.
|
* @return An element that holds the data associated with this object.
|
||||||
*/
|
*/
|
||||||
@@ -105,7 +105,7 @@ public class Source extends XmlElement implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Unmarshall the contents of the source element into the internal data objects
|
* Unmarshal the contents of the source element into the internal data objects
|
||||||
* in this object.
|
* in this object.
|
||||||
*
|
*
|
||||||
* @param source The Source element to process.
|
* @param source The Source element to process.
|
||||||
@@ -123,7 +123,7 @@ public class Source extends XmlElement implements SwordElementInterface
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param source
|
* @param source
|
||||||
* @param validate
|
* @param validationProperties
|
||||||
* @return
|
* @return
|
||||||
* @throws org.purl.sword.base.UnmarshallException
|
* @throws org.purl.sword.base.UnmarshallException
|
||||||
*/
|
*/
|
||||||
|
@@ -133,7 +133,7 @@ implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Marshall the data in this object to an Element object.
|
* Marshal the data in this object to an Element object.
|
||||||
*
|
*
|
||||||
* @return The data expressed in an Element.
|
* @return The data expressed in an Element.
|
||||||
*/
|
*/
|
||||||
@@ -154,7 +154,7 @@ implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Unmarshall the text element into this object.
|
* Unmarshal the text element into this object.
|
||||||
*
|
*
|
||||||
* This unmarshaller only handles plain text content, although it can
|
* This unmarshaller only handles plain text content, although it can
|
||||||
* recognise the three different type elements of text, html and xhtml. This
|
* recognise the three different type elements of text, html and xhtml. This
|
||||||
@@ -176,7 +176,7 @@ implements SwordElementInterface
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param text
|
* @param text
|
||||||
* @param validate
|
* @param validationProperties
|
||||||
* @return
|
* @return
|
||||||
* @throws org.purl.sword.base.UnmarshallException
|
* @throws org.purl.sword.base.UnmarshallException
|
||||||
*/
|
*/
|
||||||
|
@@ -68,7 +68,7 @@ public class AtomDocumentRequest
|
|||||||
/**
|
/**
|
||||||
* Set the username.
|
* Set the username.
|
||||||
*
|
*
|
||||||
* @param authenticatedUserName the authenticatedUserName to set
|
* @param username the authenticated UserName to set
|
||||||
*/
|
*/
|
||||||
public void setUsername(String username) {
|
public void setUsername(String username) {
|
||||||
this.username = username;
|
this.username = username;
|
||||||
@@ -104,7 +104,7 @@ public class AtomDocumentRequest
|
|||||||
/**
|
/**
|
||||||
* Set the IP address of the user
|
* Set the IP address of the user
|
||||||
*
|
*
|
||||||
* @param String the IP address
|
* @param IPAddress the IP address
|
||||||
*/
|
*/
|
||||||
public void setIPAddress(String IPAddress) {
|
public void setIPAddress(String IPAddress) {
|
||||||
this.IPAddress = IPAddress;
|
this.IPAddress = IPAddress;
|
||||||
@@ -122,7 +122,7 @@ public class AtomDocumentRequest
|
|||||||
/**
|
/**
|
||||||
* Set the location of the service document
|
* Set the location of the service document
|
||||||
*
|
*
|
||||||
* @param String the location
|
* @param location the location
|
||||||
*/
|
*/
|
||||||
public void setLocation(String location) {
|
public void setLocation(String location) {
|
||||||
this.location = location;
|
this.location = location;
|
||||||
|
@@ -69,7 +69,7 @@ implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Marshall the data in this object to an Element object.
|
* Marshal the data in this object to an Element object.
|
||||||
*
|
*
|
||||||
* @return The data expressed in an Element.
|
* @return The data expressed in an Element.
|
||||||
*/
|
*/
|
||||||
@@ -83,13 +83,14 @@ implements SwordElementInterface
|
|||||||
protected abstract void marshallContent(Element element);
|
protected abstract void marshallContent(Element element);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Unmarshall the text element into this object.
|
* Unmarshal the text element into this object.
|
||||||
*
|
*
|
||||||
* This unmarshaller only handles plain text content, although it can
|
* This unmarshaller only handles plain text content, although it can
|
||||||
* recognise the three different type elements of text, html and xhtml. This
|
* recognise the three different type elements of text, html and xhtml. This
|
||||||
* is an area that can be improved in a future implementation, if necessary.
|
* is an area that can be improved in a future implementation, if necessary.
|
||||||
*
|
*
|
||||||
* @param text The text element.
|
* @param element The text element.
|
||||||
|
* @param validationProperties
|
||||||
*
|
*
|
||||||
* @throws UnmarshallException If the specified element is not of
|
* @throws UnmarshallException If the specified element is not of
|
||||||
* the correct type, where the localname is used
|
* the correct type, where the localname is used
|
||||||
|
@@ -113,7 +113,7 @@ public class Deposit
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param authenticatedUserName the authenticatedUserName to set
|
* @param username the authenticated UserName to set
|
||||||
*/
|
*/
|
||||||
public void setUsername(String username) {
|
public void setUsername(String username) {
|
||||||
this.username = username;
|
this.username = username;
|
||||||
@@ -285,7 +285,7 @@ public class Deposit
|
|||||||
/**
|
/**
|
||||||
* Set the IP address of the user
|
* Set the IP address of the user
|
||||||
*
|
*
|
||||||
* @param String the IP address
|
* @param IPAddress the IP address
|
||||||
*/
|
*/
|
||||||
public void setIPAddress(String IPAddress) {
|
public void setIPAddress(String IPAddress) {
|
||||||
this.IPAddress = IPAddress;
|
this.IPAddress = IPAddress;
|
||||||
@@ -303,7 +303,7 @@ public class Deposit
|
|||||||
/**
|
/**
|
||||||
* Set the location of the deposit
|
* Set the location of the deposit
|
||||||
*
|
*
|
||||||
* @param String the location
|
* @param location the location
|
||||||
*/
|
*/
|
||||||
public void setLocation(String location) {
|
public void setLocation(String location) {
|
||||||
this.location = location;
|
this.location = location;
|
||||||
|
@@ -40,7 +40,7 @@ package org.purl.sword.base;
|
|||||||
* Definition of the error codes that will be used in
|
* Definition of the error codes that will be used in
|
||||||
* SWORD error documents.
|
* SWORD error documents.
|
||||||
*
|
*
|
||||||
* @see org.purl.sword.atom.SWORDErrorDocument
|
* @see SWORDErrorDocument
|
||||||
*
|
*
|
||||||
* @author Stuart Lewis
|
* @author Stuart Lewis
|
||||||
*/
|
*/
|
||||||
|
@@ -114,8 +114,8 @@ public class SWORDErrorDocument extends SWORDEntry
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Overrides the marshall method in the parent SWORDEntry. This will
|
* Overrides the marshal method in the parent SWORDEntry. This will
|
||||||
* call the parent marshall method and then add the additional
|
* call the parent marshal method and then add the additional
|
||||||
* elements that have been added in this subclass.
|
* elements that have been added in this subclass.
|
||||||
*/
|
*/
|
||||||
public Element marshall()
|
public Element marshall()
|
||||||
@@ -130,7 +130,7 @@ public class SWORDErrorDocument extends SWORDEntry
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Overrides the unmarshall method in the parent SWORDEntry. This will
|
* Overrides the unmarshal method in the parent SWORDEntry. This will
|
||||||
* call the parent method to parse the general Atom elements and
|
* call the parent method to parse the general Atom elements and
|
||||||
* attributes. This method will then parse the remaining sword
|
* attributes. This method will then parse the remaining sword
|
||||||
* extensions that exist in the element.
|
* extensions that exist in the element.
|
||||||
@@ -222,11 +222,12 @@ public class SWORDErrorDocument extends SWORDEntry
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param elements
|
* @param info
|
||||||
* @param attributes
|
* @param validationContext
|
||||||
* @return
|
* @return
|
||||||
*/
|
*/
|
||||||
protected SwordValidationInfo validate(SwordValidationInfo info, Properties validationContext)
|
protected SwordValidationInfo validate(SwordValidationInfo info,
|
||||||
|
Properties validationContext)
|
||||||
{
|
{
|
||||||
|
|
||||||
if( errorURI == null )
|
if( errorURI == null )
|
||||||
|
@@ -109,7 +109,7 @@ public class Service extends XmlElement implements SwordElementInterface
|
|||||||
/**
|
/**
|
||||||
* Create a new instance.
|
* Create a new instance.
|
||||||
*
|
*
|
||||||
* @param complianceLevel The service compliance level.
|
* @param version The service compliance level.
|
||||||
*/
|
*/
|
||||||
public Service(String version)
|
public Service(String version)
|
||||||
{
|
{
|
||||||
@@ -121,9 +121,9 @@ public class Service extends XmlElement implements SwordElementInterface
|
|||||||
* Create a new instance with the specified compliance level, noOp and
|
* Create a new instance with the specified compliance level, noOp and
|
||||||
* verbose values.
|
* verbose values.
|
||||||
*
|
*
|
||||||
* @param complianceLevel The service compliance level.
|
* @param version The service compliance level.
|
||||||
* @param noOp The noOp.
|
* @param noOp The noOp.
|
||||||
* @param verbose The verbose element.
|
* @param verbose The verbose element.
|
||||||
*/
|
*/
|
||||||
public Service(String version, boolean noOp, boolean verbose)
|
public Service(String version, boolean noOp, boolean verbose)
|
||||||
{
|
{
|
||||||
@@ -209,7 +209,7 @@ public class Service extends XmlElement implements SwordElementInterface
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Determine if the NoOp value has been set. This should be called to
|
* Determine if the NoOp value has been set. This should be called to
|
||||||
* check if an item has been programatically set and does not have a
|
* check if an item has been programmatically set and does not have a
|
||||||
* default value.
|
* default value.
|
||||||
*
|
*
|
||||||
* @return True if it has been set programmatically. Otherwise, false.
|
* @return True if it has been set programmatically. Otherwise, false.
|
||||||
@@ -251,7 +251,7 @@ public class Service extends XmlElement implements SwordElementInterface
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Determine if the Verbose value has been set. This should be called to
|
* Determine if the Verbose value has been set. This should be called to
|
||||||
* check if an item has been programatically set and does not have a
|
* check if an item has been programmatically set and does not have a
|
||||||
* default value.
|
* default value.
|
||||||
*
|
*
|
||||||
* @return True if it has been set programmatically. Otherwise, false.
|
* @return True if it has been set programmatically. Otherwise, false.
|
||||||
@@ -340,7 +340,7 @@ public class Service extends XmlElement implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Marshall the data in this object to an Element object.
|
* Marshal the data in this object to an Element object.
|
||||||
*
|
*
|
||||||
* @return A XOM Element that holds the data for this Content element.
|
* @return A XOM Element that holds the data for this Content element.
|
||||||
*/
|
*/
|
||||||
@@ -385,7 +385,7 @@ public class Service extends XmlElement implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Unmarshall the content element into the data in this object.
|
* Unmarshal the content element into the data in this object.
|
||||||
*
|
*
|
||||||
* @throws UnmarshallException If the element does not contain a
|
* @throws UnmarshallException If the element does not contain a
|
||||||
* content element or if there are problems
|
* content element or if there are problems
|
||||||
@@ -400,7 +400,7 @@ public class Service extends XmlElement implements SwordElementInterface
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param service
|
* @param service
|
||||||
* @param validate
|
* @param validationProperties
|
||||||
* @return
|
* @return
|
||||||
* @throws org.purl.sword.base.UnmarshallException
|
* @throws org.purl.sword.base.UnmarshallException
|
||||||
*/
|
*/
|
||||||
|
@@ -72,7 +72,7 @@ public class ServiceDocumentRequest
|
|||||||
/**
|
/**
|
||||||
* Set the username.
|
* Set the username.
|
||||||
*
|
*
|
||||||
* @param authenticatedUserName the authenticatedUserName to set
|
* @param username the authenticated UserName to set
|
||||||
*/
|
*/
|
||||||
public void setUsername(String username) {
|
public void setUsername(String username) {
|
||||||
this.username = username;
|
this.username = username;
|
||||||
@@ -126,7 +126,7 @@ public class ServiceDocumentRequest
|
|||||||
/**
|
/**
|
||||||
* Set the IP address of the user
|
* Set the IP address of the user
|
||||||
*
|
*
|
||||||
* @param String the IP address
|
* @param IPAddress the IP address
|
||||||
*/
|
*/
|
||||||
public void setIPAddress(String IPAddress) {
|
public void setIPAddress(String IPAddress) {
|
||||||
this.IPAddress = IPAddress;
|
this.IPAddress = IPAddress;
|
||||||
@@ -144,7 +144,7 @@ public class ServiceDocumentRequest
|
|||||||
/**
|
/**
|
||||||
* Set the location of the service document
|
* Set the location of the service document
|
||||||
*
|
*
|
||||||
* @param String the location
|
* @param location the location
|
||||||
*/
|
*/
|
||||||
public void setLocation(String location) {
|
public void setLocation(String location) {
|
||||||
this.location = location;
|
this.location = location;
|
||||||
|
@@ -107,7 +107,7 @@ implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Marshall the data in this object to an Element object.
|
* Marshal the data in this object to an Element object.
|
||||||
*
|
*
|
||||||
* @return The data expressed in an Element.
|
* @return The data expressed in an Element.
|
||||||
*/
|
*/
|
||||||
@@ -128,21 +128,22 @@ implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Unmarshall the text element into this object.
|
* Unmarshal the text element into this object.
|
||||||
*
|
*
|
||||||
* This unmarshaller only handles plain text content, although it can
|
* This unmarshaller only handles plain text content, although it can
|
||||||
* recognise the three different type elements of text, html and xhtml. This
|
* recognise the three different type elements of text, html and xhtml. This
|
||||||
* is an area that can be improved in a future implementation, if necessary.
|
* is an area that can be improved in a future implementation, if necessary.
|
||||||
*
|
*
|
||||||
* @param text The text element.
|
* @param acceptPackaging The text element.
|
||||||
|
* @param validationProperties
|
||||||
*
|
*
|
||||||
* @throws UnmarshallException If the specified element is not of
|
* @throws UnmarshallException If the specified element is not of
|
||||||
* the correct type, where the localname is used
|
* the correct type, where the localname is used
|
||||||
* to specify the valid name. Also thrown
|
* to specify the valid name. Also thrown
|
||||||
* if there is an issue accessing the data.
|
* if there is an issue accessing the data.
|
||||||
*/
|
*/
|
||||||
public SwordValidationInfo unmarshall(Element acceptPackaging, Properties validationProperties)
|
public SwordValidationInfo unmarshall(Element acceptPackaging,
|
||||||
throws UnmarshallException
|
Properties validationProperties) throws UnmarshallException
|
||||||
{
|
{
|
||||||
if( ! isInstanceOf(acceptPackaging, xmlName) )
|
if( ! isInstanceOf(acceptPackaging, xmlName) )
|
||||||
{
|
{
|
||||||
@@ -305,7 +306,7 @@ implements SwordElementInterface
|
|||||||
/**
|
/**
|
||||||
* Set the type.
|
* Set the type.
|
||||||
*
|
*
|
||||||
* @param type The type.
|
* @param value The type.
|
||||||
*/
|
*/
|
||||||
public void setQualityValue(QualityValue value)
|
public void setQualityValue(QualityValue value)
|
||||||
{
|
{
|
||||||
|
@@ -76,13 +76,13 @@ public class SwordValidationInfo {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List of validation info notes that were generated during
|
* List of validation info notes that were generated during
|
||||||
* an unmarshall stage.
|
* an unmarshal stage.
|
||||||
*/
|
*/
|
||||||
private ArrayList<SwordValidationInfo> unmarshallElementInfo;
|
private ArrayList<SwordValidationInfo> unmarshallElementInfo;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* List of validation info notes that were generated during an
|
* List of validation info notes that were generated during an
|
||||||
* unmarshall stage.
|
* unmarshal stage.
|
||||||
*/
|
*/
|
||||||
private ArrayList<SwordValidationInfo> unmarshallAttributeInfo;
|
private ArrayList<SwordValidationInfo> unmarshallAttributeInfo;
|
||||||
|
|
||||||
@@ -105,7 +105,7 @@ public class SwordValidationInfo {
|
|||||||
* Create a new information object for the specified element. Sets the
|
* Create a new information object for the specified element. Sets the
|
||||||
* default type to be VALID.
|
* default type to be VALID.
|
||||||
*
|
*
|
||||||
* @param theElement The element.
|
* @param element The element.
|
||||||
*/
|
*/
|
||||||
public SwordValidationInfo(XmlName element)
|
public SwordValidationInfo(XmlName element)
|
||||||
{
|
{
|
||||||
@@ -116,8 +116,8 @@ public class SwordValidationInfo {
|
|||||||
* Create a new information object for the specified element's
|
* Create a new information object for the specified element's
|
||||||
* attribute. Sets the default type to be VALID.
|
* attribute. Sets the default type to be VALID.
|
||||||
*
|
*
|
||||||
* @param theElement the element.
|
* @param element the element.
|
||||||
* @param theAttribute the attribute.
|
* @param attribute the attribute.
|
||||||
*/
|
*/
|
||||||
public SwordValidationInfo(XmlName element, XmlName attribute)
|
public SwordValidationInfo(XmlName element, XmlName attribute)
|
||||||
{
|
{
|
||||||
@@ -128,7 +128,7 @@ public class SwordValidationInfo {
|
|||||||
* Create a new instance of a validation information object that
|
* Create a new instance of a validation information object that
|
||||||
* reports on an element.
|
* reports on an element.
|
||||||
*
|
*
|
||||||
* @param theElement The element.
|
* @param element The element.
|
||||||
* @param theMessage The information message.
|
* @param theMessage The information message.
|
||||||
* @param theType The type of message.
|
* @param theType The type of message.
|
||||||
*/
|
*/
|
||||||
@@ -143,10 +143,8 @@ public class SwordValidationInfo {
|
|||||||
* Create a new instance of a validation information object that
|
* Create a new instance of a validation information object that
|
||||||
* reports on an attribute in the specified element.
|
* reports on an attribute in the specified element.
|
||||||
*
|
*
|
||||||
* @param elementPrefix Prefix for the element.
|
* @param element The local name for the element.
|
||||||
* @param elementName The local name for the element.
|
* @param attribute The attribute.
|
||||||
* @param attributePrefix Prefix for the attribute.
|
|
||||||
* @param attributeName The attribute.
|
|
||||||
* @param theMessage The information message.
|
* @param theMessage The information message.
|
||||||
* @param theType The type of message.
|
* @param theType The type of message.
|
||||||
*/
|
*/
|
||||||
|
@@ -169,7 +169,7 @@ public class Workspace extends XmlElement implements SwordElementInterface
|
|||||||
/**
|
/**
|
||||||
* Get a list of the collections
|
* Get a list of the collections
|
||||||
*
|
*
|
||||||
* @ return A list.
|
* @return A list.
|
||||||
*/
|
*/
|
||||||
public List<Collection> getCollections( )
|
public List<Collection> getCollections( )
|
||||||
{
|
{
|
||||||
@@ -177,7 +177,7 @@ public class Workspace extends XmlElement implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Marshall the data in this element to an Element.
|
* Marshal the data in this element to an Element.
|
||||||
*
|
*
|
||||||
* @return An element that contains the data in this object.
|
* @return An element that contains the data in this object.
|
||||||
*/
|
*/
|
||||||
@@ -201,7 +201,7 @@ public class Workspace extends XmlElement implements SwordElementInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Unmarshall the workspace element into the data in this object.
|
* Unmarshal the workspace element into the data in this object.
|
||||||
*
|
*
|
||||||
* @throws UnmarshallException If the element does not contain a
|
* @throws UnmarshallException If the element does not contain a
|
||||||
* workspace element or if there are problems
|
* workspace element or if there are problems
|
||||||
@@ -216,7 +216,7 @@ public class Workspace extends XmlElement implements SwordElementInterface
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param workspace
|
* @param workspace
|
||||||
* @param validate
|
* @param validationProperties
|
||||||
* @return
|
* @return
|
||||||
* @throws org.purl.sword.base.UnmarshallException
|
* @throws org.purl.sword.base.UnmarshallException
|
||||||
*/
|
*/
|
||||||
|
@@ -95,12 +95,14 @@ public class DummyServer implements SWORDServer {
|
|||||||
* an anonymous workspace and collection, and one personalised
|
* an anonymous workspace and collection, and one personalised
|
||||||
* for the onBehalfOf user.
|
* for the onBehalfOf user.
|
||||||
*
|
*
|
||||||
* @param onBehalfOf The user that the client is acting on behalf of
|
* @param sdr The request
|
||||||
* @throws SWORDAuthenticationException If the credentials are bad
|
* @throws SWORDAuthenticationException If the credentials are bad
|
||||||
* @throws SWORDErrorException If something goes wrong, such as
|
* @throws SWORDErrorException If something goes wrong, such as
|
||||||
*/
|
*/
|
||||||
public ServiceDocument doServiceDocument(ServiceDocumentRequest sdr)
|
public ServiceDocument doServiceDocument(ServiceDocumentRequest sdr)
|
||||||
throws SWORDAuthenticationException, SWORDErrorException, SWORDException {
|
throws SWORDAuthenticationException, SWORDErrorException,
|
||||||
|
SWORDException
|
||||||
|
{
|
||||||
// Authenticate the user
|
// Authenticate the user
|
||||||
String username = sdr.getUsername();
|
String username = sdr.getUsername();
|
||||||
String password = sdr.getPassword();
|
String password = sdr.getPassword();
|
||||||
|
@@ -419,7 +419,7 @@ public class FlowContainerUtils
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Look up the id of a group authorized for one of the given roles. If no group is currently
|
* Look up the id of a group authorized for one of the given roles. If no group is currently
|
||||||
* authorized to preform this role then a new group will be created and assigned the role.
|
* authorized to perform this role then a new group will be created and assigned the role.
|
||||||
*
|
*
|
||||||
* @param context The current DSpace context.
|
* @param context The current DSpace context.
|
||||||
* @param collectionID The collection id.
|
* @param collectionID The collection id.
|
||||||
@@ -516,7 +516,7 @@ public class FlowContainerUtils
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Second, remove all outhorizations for this role by searching for all policies that this
|
// Second, remove all authorizations for this role by searching for all policies that this
|
||||||
// group has on the collection and remove them otherwise the delete will fail because
|
// group has on the collection and remove them otherwise the delete will fail because
|
||||||
// there are dependencies.
|
// there are dependencies.
|
||||||
@SuppressWarnings("unchecked") // the cast is correct
|
@SuppressWarnings("unchecked") // the cast is correct
|
||||||
@@ -541,11 +541,10 @@ public class FlowContainerUtils
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Look up the id of a group authorized for one of the given roles. If no group is currently
|
* Look up the id of a group authorized for one of the given roles. If no group is currently
|
||||||
* authorized to preform this role then a new group will be created and assigned the role.
|
* authorized to perform this role then a new group will be created and assigned the role.
|
||||||
*
|
*
|
||||||
* @param context The current DSpace context.
|
* @param context The current DSpace context.
|
||||||
* @param collectionID The collection id.
|
* @param collectionID The collection id.
|
||||||
* @param roleName ADMIN, WF_STEP1, WF_STEP2, WF_STEP3, SUBMIT, DEFAULT_READ.
|
|
||||||
* @return The id of the group associated with that particular role.
|
* @return The id of the group associated with that particular role.
|
||||||
*/
|
*/
|
||||||
public static int getCollectionDefaultRead(Context context, int collectionID) throws SQLException, AuthorizeException
|
public static int getCollectionDefaultRead(Context context, int collectionID) throws SQLException, AuthorizeException
|
||||||
@@ -556,16 +555,16 @@ public class FlowContainerUtils
|
|||||||
Group[] bitstreamGroups = AuthorizeManager.getAuthorizedGroups(context, collection, Constants.DEFAULT_BITSTREAM_READ);
|
Group[] bitstreamGroups = AuthorizeManager.getAuthorizedGroups(context, collection, Constants.DEFAULT_BITSTREAM_READ);
|
||||||
|
|
||||||
if (itemGroups.length != 1 && bitstreamGroups.length != 1)
|
if (itemGroups.length != 1 && bitstreamGroups.length != 1)
|
||||||
// If there are more than one groups assigned either of these privleges then this role based method will not work.
|
// If there are more than one groups assigned either of these privileges then this role based method will not work.
|
||||||
// The user will need to go to the authorization section to manualy straight this out.
|
// The user will need to go to the authorization section to manually straighten this out.
|
||||||
return -1;
|
return -1;
|
||||||
|
|
||||||
Group itemGroup = itemGroups[0];
|
Group itemGroup = itemGroups[0];
|
||||||
Group bitstreamGroup = bitstreamGroups[0];
|
Group bitstreamGroup = bitstreamGroups[0];
|
||||||
|
|
||||||
if (itemGroup.getID() != bitstreamGroup.getID())
|
if (itemGroup.getID() != bitstreamGroup.getID())
|
||||||
// If the same group is not assigned both of these priveleges then this role based method will not work. The user
|
// If the same group is not assigned both of these privileges then this role based method will not work. The user
|
||||||
// will need to go to the authorization section to manualy straighten this out.
|
// will need to go to the authorization section to manually straighten this out.
|
||||||
return -1;
|
return -1;
|
||||||
|
|
||||||
|
|
||||||
@@ -574,8 +573,8 @@ public class FlowContainerUtils
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Change default privleges from the anonymous group to a new group that will be created and
|
* Change default privileges from the anonymous group to a new group that will be created and
|
||||||
* approrpate privleges assigned. The id of this new group will be returned.
|
* appropriate privileges assigned. The id of this new group will be returned.
|
||||||
*
|
*
|
||||||
* @param context The current DSpace context.
|
* @param context The current DSpace context.
|
||||||
* @param collectionID The collection id.
|
* @param collectionID The collection id.
|
||||||
@@ -592,15 +591,15 @@ public class FlowContainerUtils
|
|||||||
Group role = Group.create(context);
|
Group role = Group.create(context);
|
||||||
role.setName("COLLECTION_"+collection.getID() +"_DEFAULT_READ");
|
role.setName("COLLECTION_"+collection.getID() +"_DEFAULT_READ");
|
||||||
|
|
||||||
// Remove existing privleges from the anynomous group.
|
// Remove existing privileges from the anonymous group.
|
||||||
AuthorizeManager.removePoliciesActionFilter(context, collection, Constants.DEFAULT_ITEM_READ);
|
AuthorizeManager.removePoliciesActionFilter(context, collection, Constants.DEFAULT_ITEM_READ);
|
||||||
AuthorizeManager.removePoliciesActionFilter(context, collection, Constants.DEFAULT_BITSTREAM_READ);
|
AuthorizeManager.removePoliciesActionFilter(context, collection, Constants.DEFAULT_BITSTREAM_READ);
|
||||||
|
|
||||||
// Grant our new role the default privleges.
|
// Grant our new role the default privileges.
|
||||||
AuthorizeManager.addPolicy(context, collection, Constants.DEFAULT_ITEM_READ, role);
|
AuthorizeManager.addPolicy(context, collection, Constants.DEFAULT_ITEM_READ, role);
|
||||||
AuthorizeManager.addPolicy(context, collection, Constants.DEFAULT_BITSTREAM_READ, role);
|
AuthorizeManager.addPolicy(context, collection, Constants.DEFAULT_BITSTREAM_READ, role);
|
||||||
|
|
||||||
// Committ the changes
|
// Commit the changes
|
||||||
role.update();
|
role.update();
|
||||||
context.commit();
|
context.commit();
|
||||||
|
|
||||||
@@ -608,7 +607,7 @@ public class FlowContainerUtils
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Change the default read priveleges to the anonymous group.
|
* Change the default read privileges to the anonymous group.
|
||||||
*
|
*
|
||||||
* If getCollectionDefaultRead() returns -1 or the anonymous group then nothing
|
* If getCollectionDefaultRead() returns -1 or the anonymous group then nothing
|
||||||
* is done.
|
* is done.
|
||||||
@@ -632,7 +631,7 @@ public class FlowContainerUtils
|
|||||||
Group role = Group.find(context, roleID);
|
Group role = Group.find(context, roleID);
|
||||||
Group anonymous = Group.find(context,0);
|
Group anonymous = Group.find(context,0);
|
||||||
|
|
||||||
// Delete the old role, this will remove the default privleges.
|
// Delete the old role, this will remove the default privileges.
|
||||||
role.delete();
|
role.delete();
|
||||||
|
|
||||||
// Set anonymous as the default read group.
|
// Set anonymous as the default read group.
|
||||||
@@ -934,7 +933,7 @@ public class FlowContainerUtils
|
|||||||
* authorized to perform this role then a new group will be created and assigned the role.
|
* authorized to perform this role then a new group will be created and assigned the role.
|
||||||
*
|
*
|
||||||
* @param context The current DSpace context.
|
* @param context The current DSpace context.
|
||||||
* @param collectionID The collection id.
|
* @param communityID The collection id.
|
||||||
* @param roleName ADMIN.
|
* @param roleName ADMIN.
|
||||||
* @return The id of the group associated with that particular role, or -1 if the role was not found.
|
* @return The id of the group associated with that particular role, or -1 if the role was not found.
|
||||||
*/
|
*/
|
||||||
@@ -1043,7 +1042,7 @@ public class FlowContainerUtils
|
|||||||
// escape the ampersand correctly;
|
// escape the ampersand correctly;
|
||||||
value = escapeXMLEntities(value);
|
value = escapeXMLEntities(value);
|
||||||
|
|
||||||
// Try and parse the XML into a mini-dom
|
// Try and parse the XML into a mini-DOM
|
||||||
String xml = "<?xml version='1.0' encoding='UTF-8'?><fragment>"+value+"</fragment>";
|
String xml = "<?xml version='1.0' encoding='UTF-8'?><fragment>"+value+"</fragment>";
|
||||||
|
|
||||||
ByteArrayInputStream inputStream = null;
|
ByteArrayInputStream inputStream = null;
|
||||||
@@ -1067,7 +1066,7 @@ public class FlowContainerUtils
|
|||||||
}
|
}
|
||||||
catch (IOException ioe)
|
catch (IOException ioe)
|
||||||
{
|
{
|
||||||
// This shouldn't ever occure because we are parsing
|
// This shouldn't ever occur because we are parsing
|
||||||
// an in-memory string, but in case it does we'll just return
|
// an in-memory string, but in case it does we'll just return
|
||||||
// it as a normal error.
|
// it as a normal error.
|
||||||
return ioe.getMessage();
|
return ioe.getMessage();
|
||||||
@@ -1077,13 +1076,13 @@ public class FlowContainerUtils
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sanatize any XML that was inputed by the user, this will clean up
|
* Sanitize any XML that was inputed by the user, this will clean up
|
||||||
* any unescaped characters so that they can be stored as proper XML.
|
* any unescaped characters so that they can be stored as proper XML.
|
||||||
* These are errors that in general we want to take care of on behalf
|
* These are errors that in general we want to take care of on behalf
|
||||||
* of the user.
|
* of the user.
|
||||||
*
|
*
|
||||||
* @param value The unsantized value
|
* @param value The unsanitized value
|
||||||
* @return A sanatized value
|
* @return A sanitized value
|
||||||
*/
|
*/
|
||||||
public static String escapeXMLEntities(String value)
|
public static String escapeXMLEntities(String value)
|
||||||
{
|
{
|
||||||
|
@@ -62,7 +62,7 @@ import org.dspace.eperson.EPersonDeletionException;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Utility methods to processes actions on EPeople. These methods are used
|
* Utility methods to processes actions on EPeople. These methods are used
|
||||||
* exclusivly from the administrative flow scripts.
|
* exclusively from the administrative flow scripts.
|
||||||
*
|
*
|
||||||
* @author scott phillips
|
* @author scott phillips
|
||||||
*/
|
*/
|
||||||
@@ -86,8 +86,8 @@ public class FlowEPersonUtils {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Add a new eperson. This method will check that the email address,
|
* Add a new eperson. This method will check that the email address,
|
||||||
* first name, and last name are non empty. Also a check is preformed
|
* first name, and last name are non empty. Also a check is performed
|
||||||
* to see if the requested email address is allready in use by another
|
* to see if the requested email address is already in use by another
|
||||||
* user.
|
* user.
|
||||||
*
|
*
|
||||||
* @param context The current DSpace context
|
* @param context The current DSpace context
|
||||||
@@ -153,15 +153,17 @@ public class FlowEPersonUtils {
|
|||||||
/**
|
/**
|
||||||
* Edit an eperson's metadata, the email address, first name, and last name are all
|
* Edit an eperson's metadata, the email address, first name, and last name are all
|
||||||
* required. The user's email address can be updated but it must remain unique, if
|
* required. The user's email address can be updated but it must remain unique, if
|
||||||
* the email address allready exists then the an error is produced.
|
* the email address already exists then the an error is produced.
|
||||||
*
|
*
|
||||||
* @param context The current DSpace context
|
* @param context The current DSpace context
|
||||||
* @param request The HTTP request parameters
|
* @param request The HTTP request parameters
|
||||||
* @param objectModel Cocoon's object model
|
* @param ObjectModel Cocoon's object model
|
||||||
* @param epersonID The unique id of the eperson being edited.
|
* @param epersonID The unique id of the eperson being edited.
|
||||||
* @return A process result's object.
|
* @return A process result's object.
|
||||||
*/
|
*/
|
||||||
public static FlowResult processEditEPerson(Context context, Request request, Map ObjectModel, int epersonID) throws SQLException, AuthorizeException
|
public static FlowResult processEditEPerson(Context context,
|
||||||
|
Request request, Map ObjectModel, int epersonID)
|
||||||
|
throws SQLException, AuthorizeException
|
||||||
{
|
{
|
||||||
|
|
||||||
FlowResult result = new FlowResult();
|
FlowResult result = new FlowResult();
|
||||||
@@ -262,8 +264,8 @@ public class FlowEPersonUtils {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Log this user in as another user. If the operation failed then the flow result
|
* Log this user in as another user. If the operation failed then the flow result
|
||||||
* will be set to failure with it's mesage set correctly. Note that after logging out
|
* will be set to failure with it's message set correctly. Note that after logging out
|
||||||
* the user may not have sufficent priveleges to continue.
|
* the user may not have sufficient privileges to continue.
|
||||||
*
|
*
|
||||||
* @param context The current DSpace context.
|
* @param context The current DSpace context.
|
||||||
* @param objectModel Object model to obtain the HTTP request from.
|
* @param objectModel Object model to obtain the HTTP request from.
|
||||||
@@ -295,7 +297,7 @@ public class FlowEPersonUtils {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete the epeople specified by the epeopleIDs parameter. This assumes that the
|
* Delete the epeople specified by the epeopleIDs parameter. This assumes that the
|
||||||
* detetion has been confirmed.
|
* deletion has been confirmed.
|
||||||
*
|
*
|
||||||
* @param context The current DSpace context
|
* @param context The current DSpace context
|
||||||
* @param epeopleIDs The unique id of the eperson being edited.
|
* @param epeopleIDs The unique id of the eperson being edited.
|
||||||
|
@@ -84,7 +84,7 @@ import org.xml.sax.SAXException;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* This is an abstract search page. It is a collection of search methods that
|
* This is an abstract search page. It is a collection of search methods that
|
||||||
* are common between diffrent search implementation. An implementer must
|
* are common between different search implementation. An implementer must
|
||||||
* implement at least three methods: addBody(), getQuery(), and generateURL().
|
* implement at least three methods: addBody(), getQuery(), and generateURL().
|
||||||
*
|
*
|
||||||
* See the two implementors: SimpleSearch and AdvancedSearch.
|
* See the two implementors: SimpleSearch and AdvancedSearch.
|
||||||
@@ -166,7 +166,7 @@ public abstract class AbstractSearch extends AbstractDSpaceTransformer
|
|||||||
if (scope != null)
|
if (scope != null)
|
||||||
key += "-" + scope.getHandle();
|
key += "-" + scope.getHandle();
|
||||||
|
|
||||||
// The actualy search query.
|
// The actual search query.
|
||||||
key += "-" + getQuery();
|
key += "-" + getQuery();
|
||||||
|
|
||||||
return HashUtil.hash(key);
|
return HashUtil.hash(key);
|
||||||
@@ -241,7 +241,7 @@ public abstract class AbstractSearch extends AbstractDSpaceTransformer
|
|||||||
if (getQuery().length() > 0)
|
if (getQuery().length() > 0)
|
||||||
{
|
{
|
||||||
|
|
||||||
// Preform the actual search
|
// Perform the actual search
|
||||||
performSearch();
|
performSearch();
|
||||||
DSpaceObject searchScope = getScope();
|
DSpaceObject searchScope = getScope();
|
||||||
|
|
||||||
@@ -413,8 +413,6 @@ public abstract class AbstractSearch extends AbstractDSpaceTransformer
|
|||||||
/**
|
/**
|
||||||
* Query DSpace for a list of all items / collections / or communities that
|
* Query DSpace for a list of all items / collections / or communities that
|
||||||
* match the given search query.
|
* match the given search query.
|
||||||
*
|
|
||||||
* @return The associated query results.
|
|
||||||
*/
|
*/
|
||||||
protected void performSearch() throws SQLException, IOException, UIException
|
protected void performSearch() throws SQLException, IOException, UIException
|
||||||
{
|
{
|
||||||
|
@@ -113,7 +113,7 @@ public class CommunityBrowser extends AbstractDSpaceTransformer implements Cache
|
|||||||
/** What depth is the maximum depth of the tree */
|
/** What depth is the maximum depth of the tree */
|
||||||
protected int depth = DEFAULT_DEPTH;
|
protected int depth = DEFAULT_DEPTH;
|
||||||
|
|
||||||
/** Cached version the community / collection hierarch */
|
/** Cached version the community / collection hierarchy */
|
||||||
protected TreeNode root;
|
protected TreeNode root;
|
||||||
|
|
||||||
/** cached validity object */
|
/** cached validity object */
|
||||||
@@ -207,7 +207,7 @@ public class CommunityBrowser extends AbstractDSpaceTransformer implements Cache
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add a community-browser division that includes refrences to community and
|
* Add a community-browser division that includes references to community and
|
||||||
* collection metadata.
|
* collection metadata.
|
||||||
*/
|
*/
|
||||||
public void addBody(Body body) throws SAXException, WingException,
|
public void addBody(Body body) throws SAXException, WingException,
|
||||||
@@ -248,11 +248,11 @@ public class CommunityBrowser extends AbstractDSpaceTransformer implements Cache
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Recursively build an includeset of the community / collection hierarcher based upon
|
* Recursively build an includeset of the community / collection hierarchy based upon
|
||||||
* the given NodeTree.
|
* the given NodeTree.
|
||||||
*
|
*
|
||||||
* @param referenceSet The include set
|
* @param referenceSet The include set
|
||||||
* @param node The current node of the hierarch.
|
* @param node The current node of the hierarchy.
|
||||||
*/
|
*/
|
||||||
public void buildReferenceSet(ReferenceSet referenceSet, TreeNode node) throws WingException
|
public void buildReferenceSet(ReferenceSet referenceSet, TreeNode node) throws WingException
|
||||||
{
|
{
|
||||||
@@ -286,11 +286,11 @@ public class CommunityBrowser extends AbstractDSpaceTransformer implements Cache
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Recursively build a list of the community / collection hierarchery based upon
|
* Recursively build a list of the community / collection hierarchy based upon
|
||||||
* the given NodeTree.
|
* the given NodeTree.
|
||||||
*
|
*
|
||||||
* @param List The parent list
|
* @param list The parent list
|
||||||
* @param node The current node of the hierarch.
|
* @param node The current node of the hierarchy.
|
||||||
*/
|
*/
|
||||||
public void buildList(List list, TreeNode node) throws WingException
|
public void buildList(List list, TreeNode node) throws WingException
|
||||||
{
|
{
|
||||||
@@ -348,7 +348,7 @@ public class CommunityBrowser extends AbstractDSpaceTransformer implements Cache
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* construct a tree structure of communities and collections. The results
|
* construct a tree structure of communities and collections. The results
|
||||||
* of this hirarchy are cached so calling it multipletimes is acceptable.
|
* of this hierarchy are cached so calling it multiple times is acceptable.
|
||||||
*
|
*
|
||||||
* @param communities The root level communities
|
* @param communities The root level communities
|
||||||
* @return A root level node.
|
* @return A root level node.
|
||||||
@@ -404,7 +404,7 @@ public class CommunityBrowser extends AbstractDSpaceTransformer implements Cache
|
|||||||
/** The object this node represents */
|
/** The object this node represents */
|
||||||
private DSpaceObject dso;
|
private DSpaceObject dso;
|
||||||
|
|
||||||
/** The level in the hirarchy that this node is at. */
|
/** The level in the hierarchy that this node is at. */
|
||||||
private int level;
|
private int level;
|
||||||
|
|
||||||
/** All children of this node */
|
/** All children of this node */
|
||||||
@@ -443,7 +443,7 @@ public class CommunityBrowser extends AbstractDSpaceTransformer implements Cache
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The current level in the hirarchy of this node.
|
* @return The current level in the hierarchy of this node.
|
||||||
*/
|
*/
|
||||||
public int getLevel()
|
public int getLevel()
|
||||||
{
|
{
|
||||||
|
@@ -59,9 +59,9 @@ import org.dspace.eperson.EPerson;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Unauthenticate the current user. There is no way this action will fail,
|
* Unauthenticate the current user. There is no way this action will fail,
|
||||||
* so any components inside the action will be exceuted.
|
* so any components inside the action will be executed.
|
||||||
*
|
*
|
||||||
* This aciton will always send an HTTP redirect to the DSpace homepage.
|
* This action will always send an HTTP redirect to the DSpace homepage.
|
||||||
*
|
*
|
||||||
* Example:
|
* Example:
|
||||||
*
|
*
|
||||||
@@ -80,10 +80,12 @@ public class UnAuthenticateAction extends AbstractAction
|
|||||||
/**
|
/**
|
||||||
* Logout the current user.
|
* Logout the current user.
|
||||||
*
|
*
|
||||||
* @param pattern
|
* @param redirector
|
||||||
* un-used.
|
* @param resolver
|
||||||
* @param objectModel
|
* @param objectModel
|
||||||
* Cocoon's object model
|
* Cocoon's object model
|
||||||
|
* @param source
|
||||||
|
* @param parameters
|
||||||
*/
|
*/
|
||||||
public Map act(Redirector redirector, SourceResolver resolver, Map objectModel,
|
public Map act(Redirector redirector, SourceResolver resolver, Map objectModel,
|
||||||
String source, Parameters parameters) throws Exception
|
String source, Parameters parameters) throws Exception
|
||||||
@@ -97,7 +99,7 @@ public class UnAuthenticateAction extends AbstractAction
|
|||||||
|
|
||||||
EPerson eperson = context.getCurrentUser();
|
EPerson eperson = context.getCurrentUser();
|
||||||
|
|
||||||
// Actualy log the user out.
|
// Actually log the user out.
|
||||||
AuthenticationUtil.logOut(context,httpRequest);
|
AuthenticationUtil.logOut(context,httpRequest);
|
||||||
|
|
||||||
// Set the user as logged in for the rest of this request so that the cache does not get spoiled.
|
// Set the user as logged in for the rest of this request so that the cache does not get spoiled.
|
||||||
|
@@ -347,7 +347,7 @@ abstract public class AbstractStep extends AbstractDSpaceTransformer
|
|||||||
* default control/paging buttons appear on each submission page.
|
* default control/paging buttons appear on each submission page.
|
||||||
* <P>
|
* <P>
|
||||||
* Note: A given step may define its own buttons as necessary,
|
* Note: A given step may define its own buttons as necessary,
|
||||||
* and not call this method (since it must be explicitly envoked by
|
* and not call this method (since it must be explicitly invoked by
|
||||||
* the step's addBody() method)
|
* the step's addBody() method)
|
||||||
*
|
*
|
||||||
* @param controls
|
* @param controls
|
||||||
@@ -460,9 +460,6 @@ abstract public class AbstractStep extends AbstractDSpaceTransformer
|
|||||||
* Find the maximum step and page that the user has
|
* Find the maximum step and page that the user has
|
||||||
* reached in the submission processes.
|
* reached in the submission processes.
|
||||||
* If this submission is a workflow then return max-int.
|
* If this submission is a workflow then return max-int.
|
||||||
*
|
|
||||||
* @param context The current DSpace content
|
|
||||||
* @param id The unique ID of the current workflow/workspace
|
|
||||||
*/
|
*/
|
||||||
public double getMaxStepAndPageReached() throws SQLException {
|
public double getMaxStepAndPageReached() throws SQLException {
|
||||||
|
|
||||||
@@ -486,7 +483,7 @@ abstract public class AbstractStep extends AbstractDSpaceTransformer
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retreive error fields from the list of parameters
|
* Retrieve error fields from the list of parameters
|
||||||
* and return a List of all fields which had errors
|
* and return a List of all fields which had errors
|
||||||
*
|
*
|
||||||
* @return java.util.List of field names with errors
|
* @return java.util.List of field names with errors
|
||||||
|
@@ -55,7 +55,7 @@ import org.dspace.core.Context;
|
|||||||
/**
|
/**
|
||||||
* Remove all selected submissions. This action is used by the
|
* Remove all selected submissions. This action is used by the
|
||||||
* submission page, the user may check each unfinished submission
|
* submission page, the user may check each unfinished submission
|
||||||
* and when thy click the remove submissions button this action
|
* and when he clicks the remove submissions button this action
|
||||||
* will remove them all.
|
* will remove them all.
|
||||||
*
|
*
|
||||||
* @author Scott Phillips
|
* @author Scott Phillips
|
||||||
@@ -66,10 +66,12 @@ public class RemoveSubmissionsAction extends AbstractAction
|
|||||||
/**
|
/**
|
||||||
* Remove all selected submissions
|
* Remove all selected submissions
|
||||||
*
|
*
|
||||||
* @param pattern
|
* @param redirector
|
||||||
* un-used.
|
* @param resolver
|
||||||
* @param objectModel
|
* @param objectModel
|
||||||
* Cocoon's object model
|
* Cocoon's object model
|
||||||
|
* @param source
|
||||||
|
* @param parameters
|
||||||
*/
|
*/
|
||||||
public Map act(Redirector redirector, SourceResolver resolver, Map objectModel,
|
public Map act(Redirector redirector, SourceResolver resolver, Map objectModel,
|
||||||
String source, Parameters parameters) throws Exception
|
String source, Parameters parameters) throws Exception
|
||||||
|
@@ -55,7 +55,7 @@ import org.dspace.workflow.WorkflowManager;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Claim all the selected workflows. This action is used by the
|
* Claim all the selected workflows. This action is used by the
|
||||||
* submission page, when the user clicks the claim tasks botton.
|
* submission page, when the user clicks the claim tasks button.
|
||||||
*
|
*
|
||||||
* @author Scott Phillips
|
* @author Scott Phillips
|
||||||
*/
|
*/
|
||||||
@@ -63,10 +63,12 @@ public class ClaimTasksAction extends AbstractAction
|
|||||||
{
|
{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param pattern
|
* @param redirector
|
||||||
* un-used.
|
* @param resolver
|
||||||
* @param objectModel
|
* @param objectModel
|
||||||
* Cocoon's object model
|
* Cocoon's object model
|
||||||
|
* @param source
|
||||||
|
* @param parameters
|
||||||
*/
|
*/
|
||||||
public Map act(Redirector redirector, SourceResolver resolver, Map objectModel,
|
public Map act(Redirector redirector, SourceResolver resolver, Map objectModel,
|
||||||
String source, Parameters parameters) throws Exception
|
String source, Parameters parameters) throws Exception
|
||||||
@@ -83,7 +85,7 @@ public class ClaimTasksAction extends AbstractAction
|
|||||||
WorkflowItem workflowItem = WorkflowItem.find(context, Integer.valueOf(workflowID));
|
WorkflowItem workflowItem = WorkflowItem.find(context, Integer.valueOf(workflowID));
|
||||||
|
|
||||||
int state = workflowItem.getState();
|
int state = workflowItem.getState();
|
||||||
// Only unclaim tasks that are allready claimed.
|
// Only unclaim tasks that are already claimed.
|
||||||
if ( state == WorkflowManager.WFSTATE_STEP1POOL ||
|
if ( state == WorkflowManager.WFSTATE_STEP1POOL ||
|
||||||
state == WorkflowManager.WFSTATE_STEP2POOL ||
|
state == WorkflowManager.WFSTATE_STEP2POOL ||
|
||||||
state == WorkflowManager.WFSTATE_STEP3POOL)
|
state == WorkflowManager.WFSTATE_STEP3POOL)
|
||||||
|
@@ -141,7 +141,7 @@ public class DSpaceLocaleAction extends ServiceableAction implements Configurabl
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This validator class workes with cocoon's i18nutils class to test if locales are valid.
|
* This validator class works with cocoon's i18nutils class to test if locales are valid.
|
||||||
* For dspace we define a locale as valid if it is listed in xmlui.supported.locales config
|
* For dspace we define a locale as valid if it is listed in xmlui.supported.locales config
|
||||||
* parameter.
|
* parameter.
|
||||||
*/
|
*/
|
||||||
@@ -176,8 +176,8 @@ public class DSpaceLocaleAction extends ServiceableAction implements Configurabl
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param name of the locale (for debugging)
|
* @param name name of the locale (for debugging)
|
||||||
* @param locale to test
|
* @param test locale to test
|
||||||
* @return true if locale satisfies validator's criteria
|
* @return true if locale satisfies validator's criteria
|
||||||
*/
|
*/
|
||||||
public boolean test(String name, Locale test)
|
public boolean test(String name, Locale test)
|
||||||
|
@@ -59,16 +59,6 @@ import org.dspace.content.DSpaceObject;
|
|||||||
import org.dspace.core.ConfigurationManager;
|
import org.dspace.core.ConfigurationManager;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This class determines the correct Aspect to use. This is determined by the
|
|
||||||
* url string, if it is prepended with a number followed by a slash (such as 1/
|
|
||||||
* or 3/) then the Aspect identified by the number is used. When the URL does
|
|
||||||
* not start with an integer then the first Aspect (aspect zero) is loaded.
|
|
||||||
*
|
|
||||||
* Once the Aspect has been identified the following sitemap parameters are
|
|
||||||
* provided: {ID} is the Aspect ID, {aspect} is the path to the aspect,
|
|
||||||
* {aspectName} is a unique name for the aspect, and {prefix} is the aspect
|
|
||||||
* identifier prepending the URL (if one exists!).
|
|
||||||
*
|
|
||||||
* This class determines the correct Theme to apply to the URL. This is
|
* This class determines the correct Theme to apply to the URL. This is
|
||||||
* determined by the Theme rules defined in the xmlui.xml configuration file.
|
* determined by the Theme rules defined in the xmlui.xml configuration file.
|
||||||
* Each rule is evaluated in order and the first rule to match is the selected
|
* Each rule is evaluated in order and the first rule to match is the selected
|
||||||
@@ -84,11 +74,13 @@ import org.dspace.core.ConfigurationManager;
|
|||||||
public class ThemeMatcher extends AbstractLogEnabled implements Matcher {
|
public class ThemeMatcher extends AbstractLogEnabled implements Matcher {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param pattern
|
* @param src
|
||||||
* name of sitemap parameter to find
|
* name of sitemap parameter to find (ignored)
|
||||||
* @param objectModel
|
* @param objectModel
|
||||||
* environment passed through via cocoon
|
* environment passed through via cocoon
|
||||||
* @return null or map containing value of sitemap parameter 'pattern'
|
* @param parameters
|
||||||
|
* parameters passed to this matcher in the sitemap
|
||||||
|
* @return null or map containing value of sitemap parameter 'src'
|
||||||
*/
|
*/
|
||||||
public Map match(String src, Map objectModel, Parameters parameters)
|
public Map match(String src, Map objectModel, Parameters parameters)
|
||||||
throws PatternException {
|
throws PatternException {
|
||||||
|
@@ -79,7 +79,7 @@ public class XMLUIConfiguration
|
|||||||
* supplied but only the first valid file (exists and readable) will
|
* supplied but only the first valid file (exists and readable) will
|
||||||
* be used.
|
* be used.
|
||||||
*
|
*
|
||||||
* @param configPath Multiple paths configuration paths may be specified
|
* @param configPaths Multiple paths configuration paths may be specified
|
||||||
*/
|
*/
|
||||||
public static void loadConfig(String ... configPaths) throws IOException,
|
public static void loadConfig(String ... configPaths) throws IOException,
|
||||||
JDOMException
|
JDOMException
|
||||||
|
@@ -70,8 +70,8 @@ import org.xml.sax.helpers.NamespaceSupport;
|
|||||||
* translate a given type of DSpace object into a METS document for rendering
|
* translate a given type of DSpace object into a METS document for rendering
|
||||||
* into the DRI document.
|
* into the DRI document.
|
||||||
*
|
*
|
||||||
* This class provides the chasses for those unique parts of the document to be
|
* This class provides the chassis for those unique parts of the document to be
|
||||||
* build upon, there are seven rendering methods that may be overriden for each
|
* build upon, there are seven rendering methods that may be overridden for each
|
||||||
* section of the METS document.
|
* section of the METS document.
|
||||||
*
|
*
|
||||||
* Header
|
* Header
|
||||||
@@ -98,12 +98,12 @@ public abstract class AbstractAdapter
|
|||||||
public static final Namespace DIM = new Namespace(DIM_URI);
|
public static final Namespace DIM = new Namespace(DIM_URI);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A sequence used to generate unquie mets ids.
|
* A sequence used to generate unique mets ids.
|
||||||
*/
|
*/
|
||||||
private int idSequence = 0;
|
private int idSequence = 0;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The contextPath of this webapplication, used for generateing urls.
|
* The contextPath of this web application, used for generating URLs.
|
||||||
*/
|
*/
|
||||||
protected String contextPath;
|
protected String contextPath;
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ public abstract class AbstractAdapter
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Construct a new adapter, implementers must use call this method so
|
* Construct a new adapter, implementers must use call this method so
|
||||||
* the approprate internal values are insured to be set correctly.
|
* the appropriate internal values are insured to be set correctly.
|
||||||
*
|
*
|
||||||
* @param contextPath
|
* @param contextPath
|
||||||
* The contextPath of this web application.
|
* The contextPath of this web application.
|
||||||
@@ -128,7 +128,7 @@ public abstract class AbstractAdapter
|
|||||||
this.contextPath = contextPath;
|
this.contextPath = contextPath;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** The variables that dicatacte what part of the METS document to render */
|
/** The variables that dictate what part of the METS document to render */
|
||||||
List<String> sections = new ArrayList<String>();
|
List<String> sections = new ArrayList<String>();
|
||||||
List<String> dmdTypes = new ArrayList<String>();
|
List<String> dmdTypes = new ArrayList<String>();
|
||||||
HashMap<String,List> amdTypes = new HashMap<String,List>();
|
HashMap<String,List> amdTypes = new HashMap<String,List>();
|
||||||
@@ -136,10 +136,10 @@ public abstract class AbstractAdapter
|
|||||||
List<String> structTypes = new ArrayList<String>();
|
List<String> structTypes = new ArrayList<String>();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A comma seperated list of METS sections to render. If no value
|
* A comma separated list of METS sections to render. If no value
|
||||||
* is provided then all METS sections are rendered.
|
* is provided then all METS sections are rendered.
|
||||||
*
|
*
|
||||||
* @param sections Comma seperated list of METS sections.
|
* @param sections Comma separated list of METS sections.
|
||||||
*/
|
*/
|
||||||
public void setSections(String sections)
|
public void setSections(String sections)
|
||||||
{
|
{
|
||||||
@@ -153,10 +153,10 @@ public abstract class AbstractAdapter
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A comma seperated list of METS descriptive metadata formats to
|
* A comma separated list of METS descriptive metadata formats to
|
||||||
* render. If no value is provided then only the DIM format is used.
|
* render. If no value is provided then only the DIM format is used.
|
||||||
*
|
*
|
||||||
* @param sections Comma seperated list of METS metadata types.
|
* @param dmdTypes Comma separated list of METS metadata types.
|
||||||
*/
|
*/
|
||||||
public void setDmdTypes(String dmdTypes)
|
public void setDmdTypes(String dmdTypes)
|
||||||
{
|
{
|
||||||
@@ -175,7 +175,7 @@ public abstract class AbstractAdapter
|
|||||||
*
|
*
|
||||||
* @param amdSec Section of <amdSec> where this administrative metadata
|
* @param amdSec Section of <amdSec> where this administrative metadata
|
||||||
* will be rendered
|
* will be rendered
|
||||||
* @param mdTypes Comma seperated list of METS metadata types.
|
* @param mdTypes Comma separated list of METS metadata types.
|
||||||
*/
|
*/
|
||||||
public void setAmdTypes(String amdSec, String mdTypes)
|
public void setAmdTypes(String amdSec, String mdTypes)
|
||||||
{
|
{
|
||||||
@@ -192,10 +192,10 @@ public abstract class AbstractAdapter
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A comma seperated list of METS technical metadata formats to
|
* A comma separated list of METS technical metadata formats to
|
||||||
* render.
|
* render.
|
||||||
*
|
*
|
||||||
* @param techMDTypes Comma seperated list of METS metadata types.
|
* @param techMDTypes Comma separated list of METS metadata types.
|
||||||
*/
|
*/
|
||||||
public void setTechMDTypes(String techMDTypes)
|
public void setTechMDTypes(String techMDTypes)
|
||||||
{
|
{
|
||||||
@@ -203,10 +203,10 @@ public abstract class AbstractAdapter
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A comma seperated list of METS intellectual property rights metadata
|
* A comma separated list of METS intellectual property rights metadata
|
||||||
* formats to render.
|
* formats to render.
|
||||||
*
|
*
|
||||||
* @param rightsMDTypes Comma seperated list of METS metadata types.
|
* @param rightsMDTypes Comma separated list of METS metadata types.
|
||||||
*/
|
*/
|
||||||
public void setRightsMDTypes(String rightsMDTypes)
|
public void setRightsMDTypes(String rightsMDTypes)
|
||||||
{
|
{
|
||||||
@@ -214,10 +214,10 @@ public abstract class AbstractAdapter
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A comma seperated list of METS source metadata
|
* A comma separated list of METS source metadata
|
||||||
* formats to render.
|
* formats to render.
|
||||||
*
|
*
|
||||||
* @param sourceMDTypes Comma seperated list of METS metadata types.
|
* @param sourceMDTypes Comma separated list of METS metadata types.
|
||||||
*/
|
*/
|
||||||
public void setSourceMDTypes(String sourceMDTypes)
|
public void setSourceMDTypes(String sourceMDTypes)
|
||||||
{
|
{
|
||||||
@@ -225,10 +225,10 @@ public abstract class AbstractAdapter
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A comma seperated list of METS digital provenance metadata
|
* A comma separated list of METS digital provenance metadata
|
||||||
* formats to render.
|
* formats to render.
|
||||||
*
|
*
|
||||||
* @param digiprovMDTypes Comma seperated list of METS metadata types.
|
* @param digiprovMDTypes Comma separated list of METS metadata types.
|
||||||
*/
|
*/
|
||||||
public void setDigiProvMDTypes(String digiprovMDTypes)
|
public void setDigiProvMDTypes(String digiprovMDTypes)
|
||||||
{
|
{
|
||||||
@@ -236,10 +236,10 @@ public abstract class AbstractAdapter
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A comma seperated list of METS fileGrps to render. If no value
|
* A comma separated list of METS fileGrps to render. If no value
|
||||||
* is provided then all groups are rendered.
|
* is provided then all groups are rendered.
|
||||||
*
|
*
|
||||||
* @param sections Comma seperated list of METS file groups.
|
* @param fileGrpTypes Comma separated list of METS file groups.
|
||||||
*/
|
*/
|
||||||
public void setFileGrpTypes(String fileGrpTypes)
|
public void setFileGrpTypes(String fileGrpTypes)
|
||||||
{
|
{
|
||||||
@@ -253,10 +253,10 @@ public abstract class AbstractAdapter
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A comma seperated list of METS structural types to render. If no
|
* A comma separated list of METS structural types to render. If no
|
||||||
* value is provided then only the DIM format is used.
|
* value is provided then only the DIM format is used.
|
||||||
*
|
*
|
||||||
* @param sections Comma seperated list of METS structure types.
|
* @param structTypes Comma separated list of METS structure types.
|
||||||
*/
|
*/
|
||||||
public void setStructTypes(String structTypes)
|
public void setStructTypes(String structTypes)
|
||||||
{
|
{
|
||||||
@@ -349,7 +349,7 @@ public abstract class AbstractAdapter
|
|||||||
|
|
||||||
startElement(METS,"METS",attributes);
|
startElement(METS,"METS",attributes);
|
||||||
|
|
||||||
// If the user requested no specefic sections then render them all.
|
// If the user requested no specific sections then render them all.
|
||||||
boolean all = (sections.size() == 0);
|
boolean all = (sections.size() == 0);
|
||||||
|
|
||||||
if (all || sections.contains("metsHdr"))
|
if (all || sections.contains("metsHdr"))
|
||||||
@@ -397,7 +397,7 @@ public abstract class AbstractAdapter
|
|||||||
* Generate a METS file element for a given bitstream.
|
* Generate a METS file element for a given bitstream.
|
||||||
*
|
*
|
||||||
* @param item
|
* @param item
|
||||||
* If the bitstream is associated with an item provid the item
|
* If the bitstream is associated with an item provide the item
|
||||||
* otherwise leave null.
|
* otherwise leave null.
|
||||||
* @param bitstream
|
* @param bitstream
|
||||||
* The bitstream to build a file element for.
|
* The bitstream to build a file element for.
|
||||||
@@ -406,7 +406,6 @@ public abstract class AbstractAdapter
|
|||||||
* @param groupID
|
* @param groupID
|
||||||
* The group id for this file, if it is derived from another file
|
* The group id for this file, if it is derived from another file
|
||||||
* then they should share the same groupID.
|
* then they should share the same groupID.
|
||||||
* @return The METS file element.
|
|
||||||
*/
|
*/
|
||||||
protected void renderFile(Item item, Bitstream bitstream, String fileID, String groupID) throws SAXException
|
protected void renderFile(Item item, Bitstream bitstream, String fileID, String groupID) throws SAXException
|
||||||
{
|
{
|
||||||
@@ -417,7 +416,7 @@ public abstract class AbstractAdapter
|
|||||||
* Generate a METS file element for a given bitstream.
|
* Generate a METS file element for a given bitstream.
|
||||||
*
|
*
|
||||||
* @param item
|
* @param item
|
||||||
* If the bitstream is associated with an item provid the item
|
* If the bitstream is associated with an item provide the item
|
||||||
* otherwise leave null.
|
* otherwise leave null.
|
||||||
* @param bitstream
|
* @param bitstream
|
||||||
* The bitstream to build a file element for.
|
* The bitstream to build a file element for.
|
||||||
@@ -429,7 +428,6 @@ public abstract class AbstractAdapter
|
|||||||
* @param admID
|
* @param admID
|
||||||
* The IDs of the administrative metadata sections which pertain
|
* The IDs of the administrative metadata sections which pertain
|
||||||
* to this file
|
* to this file
|
||||||
* @return The METS file element.
|
|
||||||
*/
|
*/
|
||||||
protected void renderFile(Item item, Bitstream bitstream, String fileID, String groupID, String admID) throws SAXException
|
protected void renderFile(Item item, Bitstream bitstream, String fileID, String groupID, String admID) throws SAXException
|
||||||
{
|
{
|
||||||
@@ -469,10 +467,10 @@ public abstract class AbstractAdapter
|
|||||||
String description = bitstream.getDescription();
|
String description = bitstream.getDescription();
|
||||||
|
|
||||||
|
|
||||||
// If possible refrence this bitstream via a handle, however this may
|
// If possible reference this bitstream via a handle, however this may
|
||||||
// be null if a handle has not yet been assigned. In this case refrence the
|
// be null if a handle has not yet been assigned. In this case reference the
|
||||||
// item its internal id. In the last case where the bitstream is not associated
|
// item its internal id. In the last case where the bitstream is not associated
|
||||||
// with an item (such as a community logo) then refrence the bitstreamID directly.
|
// with an item (such as a community logo) then reference the bitstreamID directly.
|
||||||
String identifier = null;
|
String identifier = null;
|
||||||
if (item != null && item.getHandle() != null)
|
if (item != null && item.getHandle() != null)
|
||||||
identifier = "handle/"+item.getHandle();
|
identifier = "handle/"+item.getHandle();
|
||||||
@@ -493,7 +491,7 @@ public abstract class AbstractAdapter
|
|||||||
catch (UnsupportedEncodingException uee)
|
catch (UnsupportedEncodingException uee)
|
||||||
{
|
{
|
||||||
// just ignore it, we don't have to have a pretty
|
// just ignore it, we don't have to have a pretty
|
||||||
// name on the end of the url because the sequence id will
|
// name on the end of the URL because the sequence id will
|
||||||
// locate it. However it means that links in this file might
|
// locate it. However it means that links in this file might
|
||||||
// not work....
|
// not work....
|
||||||
}
|
}
|
||||||
@@ -527,7 +525,7 @@ public abstract class AbstractAdapter
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* Generate a unique METS id. For consistancy, all prefixs should probably
|
* Generate a unique METS id. For consistency, all prefixes should probably
|
||||||
* end in an underscore, "_".
|
* end in an underscore, "_".
|
||||||
*
|
*
|
||||||
* @param prefix
|
* @param prefix
|
||||||
@@ -548,7 +546,7 @@ public abstract class AbstractAdapter
|
|||||||
*/
|
*/
|
||||||
public DisseminationCrosswalk getDisseminationCrosswalk(String crosswalkName) throws WingException
|
public DisseminationCrosswalk getDisseminationCrosswalk(String crosswalkName) throws WingException
|
||||||
{
|
{
|
||||||
// Fixme add some caching here
|
// FIXME add some caching here
|
||||||
DisseminationCrosswalk crosswalk = (DisseminationCrosswalk) PluginManager.getNamedPlugin(DisseminationCrosswalk.class, crosswalkName);
|
DisseminationCrosswalk crosswalk = (DisseminationCrosswalk) PluginManager.getNamedPlugin(DisseminationCrosswalk.class, crosswalkName);
|
||||||
|
|
||||||
if (crosswalk == null)
|
if (crosswalk == null)
|
||||||
@@ -566,7 +564,7 @@ public abstract class AbstractAdapter
|
|||||||
{"MARC","MODS","EAD","DC","NISOIMG","LC-AV","VRA","TEIHDR","DDI","FGDC","PREMIS"/*,"OTHER"*/};
|
{"MARC","MODS","EAD","DC","NISOIMG","LC-AV","VRA","TEIHDR","DDI","FGDC","PREMIS"/*,"OTHER"*/};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Determine if the provided metadata type is a stardard METS
|
* Determine if the provided metadata type is a standard METS
|
||||||
* defined type. If it is not, use the other string.
|
* defined type. If it is not, use the other string.
|
||||||
*
|
*
|
||||||
* @param metadataType type name
|
* @param metadataType type name
|
||||||
@@ -598,12 +596,6 @@ public abstract class AbstractAdapter
|
|||||||
/**
|
/**
|
||||||
* Send the SAX events to start this element.
|
* Send the SAX events to start this element.
|
||||||
*
|
*
|
||||||
* @param contentHandler
|
|
||||||
* (Required) The registered contentHandler where SAX events
|
|
||||||
* should be routed too.
|
|
||||||
* @param namespaces
|
|
||||||
* (Required) SAX Helper class to keep track of namespaces able
|
|
||||||
* to determine the correct prefix for a given namespace URI.
|
|
||||||
* @param namespace
|
* @param namespace
|
||||||
* (Required) The namespace of this element.
|
* (Required) The namespace of this element.
|
||||||
* @param name
|
* @param name
|
||||||
@@ -611,7 +603,8 @@ public abstract class AbstractAdapter
|
|||||||
* @param attributes
|
* @param attributes
|
||||||
* (May be null) Attributes for this element
|
* (May be null) Attributes for this element
|
||||||
*/
|
*/
|
||||||
protected void startElement(Namespace namespace, String name, AttributeMap ... attributes) throws SAXException
|
protected void startElement(Namespace namespace, String name,
|
||||||
|
AttributeMap... attributes) throws SAXException
|
||||||
{
|
{
|
||||||
contentHandler.startElement(namespace.URI, name, qName(namespace, name),
|
contentHandler.startElement(namespace.URI, name, qName(namespace, name),
|
||||||
map2sax(namespace,attributes));
|
map2sax(namespace,attributes));
|
||||||
@@ -621,9 +614,6 @@ public abstract class AbstractAdapter
|
|||||||
* Send the SAX event for these plain characters, not wrapped in any
|
* Send the SAX event for these plain characters, not wrapped in any
|
||||||
* elements.
|
* elements.
|
||||||
*
|
*
|
||||||
* @param contentHandler
|
|
||||||
* (Required) The registered contentHandler where SAX events
|
|
||||||
* should be routed too.
|
|
||||||
* @param characters
|
* @param characters
|
||||||
* (May be null) Characters to send.
|
* (May be null) Characters to send.
|
||||||
*/
|
*/
|
||||||
@@ -639,12 +629,6 @@ public abstract class AbstractAdapter
|
|||||||
/**
|
/**
|
||||||
* Send the SAX events to end this element.
|
* Send the SAX events to end this element.
|
||||||
*
|
*
|
||||||
* @param contentHandler
|
|
||||||
* (Required) The registered contentHandler where SAX events
|
|
||||||
* should be routed too.
|
|
||||||
* @param namespaces
|
|
||||||
* (Required) SAX Helper class to keep track of namespaces able
|
|
||||||
* to determine the correct prefix for a given namespace URI.
|
|
||||||
* @param namespace
|
* @param namespace
|
||||||
* (Required) The namespace of this element.
|
* (Required) The namespace of this element.
|
||||||
* @param name
|
* @param name
|
||||||
|
@@ -49,17 +49,17 @@ import org.xml.sax.helpers.NamespaceSupport;
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This is a swiss army like SAX Filter, it's purpose is to filter out
|
* This is a Swiss army like SAX Filter, its purpose is to filter out
|
||||||
* undesierable SAX events from the stream. The primary application of
|
* undesirable SAX events from the stream. The primary application of
|
||||||
* this is for inserting SAX fragment into an existing SAX pipeline,
|
* this is for inserting SAX fragment into an existing SAX pipeline,
|
||||||
* under this senario you would not want new startDocument or
|
* under this scenario you would not want new startDocument or
|
||||||
* endDocument events interfering with the existing pipeline thus
|
* endDocument events interfering with the existing pipeline thus
|
||||||
* this class can filter those out.
|
* this class can filter those out.
|
||||||
*
|
*
|
||||||
* The swiss army part comes in because it's configurable. Instead of
|
* The Swiss army part comes in because it's configurable. Instead of
|
||||||
* defining a static set of events that are filled out by default all
|
* defining a static set of events that are filled out by default all
|
||||||
* events are filled out and must be turned on to allow each type
|
* events are filled out and must be turned on to allow each type
|
||||||
* individualy.
|
* Individually.
|
||||||
*
|
*
|
||||||
* Primarily you can filter events based upon their type, i.e. start/end
|
* Primarily you can filter events based upon their type, i.e. start/end
|
||||||
* elements or start/end documents. However there is one special control,
|
* elements or start/end documents. However there is one special control,
|
||||||
@@ -93,24 +93,24 @@ public class SAXFilter implements ContentHandler, LexicalHandler
|
|||||||
/**
|
/**
|
||||||
* The current XML level, each time start element is encountered this
|
* The current XML level, each time start element is encountered this
|
||||||
* is increased, and each time an end element is encountered it is
|
* is increased, and each time an end element is encountered it is
|
||||||
* decressed.
|
* decreased.
|
||||||
*/
|
*/
|
||||||
private int currentElementLevel = 0;
|
private int currentElementLevel = 0;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* If no uri is provided then substitute this default prefix and URI:
|
* If no URI is provided then substitute this default prefix and URI:
|
||||||
*/
|
*/
|
||||||
private String defaultURI;
|
private String defaultURI;
|
||||||
|
|
||||||
/** The sax handlers and namespace support */
|
/** The SAX handlers and namespace support */
|
||||||
private ContentHandler contentHandler;
|
private ContentHandler contentHandler;
|
||||||
private LexicalHandler lexicalHandler;
|
private LexicalHandler lexicalHandler;
|
||||||
private NamespaceSupport namespaces;
|
private NamespaceSupport namespaces;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Construct a new SAXFilter such that the allowed events will be routed
|
* Construct a new SAXFilter such that the allowed events will be routed
|
||||||
* to the corresponding content and lexcial handlers.
|
* to the corresponding content and lexical handlers.
|
||||||
*
|
*
|
||||||
* @param contentHandler The SAX content handler.
|
* @param contentHandler The SAX content handler.
|
||||||
* @param lexicalHandler The SAX lexical handler.
|
* @param lexicalHandler The SAX lexical handler.
|
||||||
@@ -160,8 +160,8 @@ public class SAXFilter implements ContentHandler, LexicalHandler
|
|||||||
* they are below the given XML level. I.e. each nested
|
* they are below the given XML level. I.e. each nested
|
||||||
* element is a new level.
|
* element is a new level.
|
||||||
*
|
*
|
||||||
* @param belowElementLevel
|
* @param minimumElementLevel
|
||||||
* the minumum level required.
|
* the minimum level required.
|
||||||
* @return
|
* @return
|
||||||
*/
|
*/
|
||||||
public SAXFilter allowElements(int minimumElementLevel)
|
public SAXFilter allowElements(int minimumElementLevel)
|
||||||
|
@@ -137,7 +137,7 @@ public class Include extends AbstractTransformer implements CacheableProcessingC
|
|||||||
* Read in the given src path into an internal DOM for later processing when
|
* Read in the given src path into an internal DOM for later processing when
|
||||||
* needed.
|
* needed.
|
||||||
*
|
*
|
||||||
* @param sourceResolver
|
* @param resolver
|
||||||
* Resolver for cocoon pipelines.
|
* Resolver for cocoon pipelines.
|
||||||
* @param objectModel
|
* @param objectModel
|
||||||
* The pipelines's object model.
|
* The pipelines's object model.
|
||||||
|
@@ -102,7 +102,7 @@ public class Message
|
|||||||
* current translate object but instead create a
|
* current translate object but instead create a
|
||||||
* cloned copy that has been parameterized.
|
* cloned copy that has been parameterized.
|
||||||
*
|
*
|
||||||
* @param object The dictionary parameters
|
* @param dictionaryParameters The dictionary parameters
|
||||||
*/
|
*/
|
||||||
public Message parameterize(Object ... dictionaryParameters)
|
public Message parameterize(Object ... dictionaryParameters)
|
||||||
{
|
{
|
||||||
|
@@ -95,7 +95,7 @@ public class WingContext
|
|||||||
/**
|
/**
|
||||||
* Return the cocoon logger
|
* Return the cocoon logger
|
||||||
*
|
*
|
||||||
* @return
|
* @return the current logger
|
||||||
*/
|
*/
|
||||||
public Log getLogger()
|
public Log getLogger()
|
||||||
{
|
{
|
||||||
@@ -105,8 +105,8 @@ public class WingContext
|
|||||||
/**
|
/**
|
||||||
* Set the cocoon logger
|
* Set the cocoon logger
|
||||||
*
|
*
|
||||||
* @param contentHandler
|
* @param log
|
||||||
* A new content handler.
|
* A new logger.
|
||||||
*/
|
*/
|
||||||
public void setLogger(Log log)
|
public void setLogger(Log log)
|
||||||
{
|
{
|
||||||
|
@@ -212,7 +212,7 @@ public abstract class AbstractWingElement implements WingElement
|
|||||||
*
|
*
|
||||||
* @param parameter
|
* @param parameter
|
||||||
* An int who's value is less than lesser.
|
* An int who's value is less than lesser.
|
||||||
* @param greater
|
* @param lesser
|
||||||
* An int who's value is greater that lesser.
|
* An int who's value is greater that lesser.
|
||||||
* @param message
|
* @param message
|
||||||
* The exception message thrown if the parameter is invalid.
|
* The exception message thrown if the parameter is invalid.
|
||||||
|
@@ -104,9 +104,9 @@ public class Button extends Field
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the button's label, removing any previous label's
|
* Set the button's label, removing any previous labels.
|
||||||
*
|
*
|
||||||
* @param translate
|
* @param translated
|
||||||
* (Required) A key into the i18n catalogue for translation into
|
* (Required) A key into the i18n catalogue for translation into
|
||||||
* the user's preferred language.
|
* the user's preferred language.
|
||||||
*/
|
*/
|
||||||
|
@@ -127,10 +127,10 @@ public class Division extends AbstractWingElement implements StructuralElement,
|
|||||||
/** What method should this interactive division use for posting the result? */
|
/** What method should this interactive division use for posting the result? */
|
||||||
private String method;
|
private String method;
|
||||||
|
|
||||||
/** Does this interactive division support the ajax behavior? */
|
/** Does this interactive division support the AJAX behavior? */
|
||||||
private boolean behaviorAJAXenabled = false;
|
private boolean behaviorAJAXenabled = false;
|
||||||
|
|
||||||
/** A list of fields which need to be handled specialy when using bhavior */
|
/** A list of fields which need to be handled specially when using behavior */
|
||||||
private String behaviorSensitiveFields;
|
private String behaviorSensitiveFields;
|
||||||
|
|
||||||
/** Special rendering instructions */
|
/** Special rendering instructions */
|
||||||
@@ -148,7 +148,7 @@ public class Division extends AbstractWingElement implements StructuralElement,
|
|||||||
*/
|
*/
|
||||||
private String paginationType;
|
private String paginationType;
|
||||||
|
|
||||||
/** Url to the previousPage. (used by simple pagination) */
|
/** URL to the previousPage. (used by simple pagination) */
|
||||||
private String previousPage;
|
private String previousPage;
|
||||||
|
|
||||||
/** URL to the nextPage. (used by simple pagination) */
|
/** URL to the nextPage. (used by simple pagination) */
|
||||||
@@ -161,30 +161,30 @@ public class Division extends AbstractWingElement implements StructuralElement,
|
|||||||
private int itemsTotal;
|
private int itemsTotal;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The index of the first item inculded in this div. (used by both
|
* The index of the first item included in this div. (used by both
|
||||||
* pagination types)
|
* pagination types)
|
||||||
*/
|
*/
|
||||||
private int firstItemIndex;
|
private int firstItemIndex;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The index of the first item inculded in this div. (used by both
|
* The index of the first item included in this div. (used by both
|
||||||
* pagination types)
|
* pagination types)
|
||||||
*/
|
*/
|
||||||
private int lastItemIndex;
|
private int lastItemIndex;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The index the current page being displayed. (used by maksed pagination
|
* The index the current page being displayed. (used by masked pagination
|
||||||
* type)
|
* type)
|
||||||
*/
|
*/
|
||||||
private int currentPage;
|
private int currentPage;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The total number of pages in the pagination set. (used by maksed
|
* The total number of pages in the pagination set. (used by masked
|
||||||
* pagination type)
|
* pagination type)
|
||||||
*/
|
*/
|
||||||
private int pagesTotal;
|
private int pagesTotal;
|
||||||
|
|
||||||
/** The pagination URL mask. (used by maksed pagination type) */
|
/** The pagination URL mask. (used by masked pagination type) */
|
||||||
private String pageURLMask;
|
private String pageURLMask;
|
||||||
|
|
||||||
/** The possible interactive division methods: get,post, or multipart. */
|
/** The possible interactive division methods: get,post, or multipart. */
|
||||||
@@ -315,7 +315,7 @@ public class Division extends AbstractWingElement implements StructuralElement,
|
|||||||
* simple page paradigm.
|
* simple page paradigm.
|
||||||
*
|
*
|
||||||
* @param itemsTotal
|
* @param itemsTotal
|
||||||
* (Required) How many items exist accross all paginated divs.
|
* (Required) How many items exist across all paginated divs.
|
||||||
* @param firstItemIndex
|
* @param firstItemIndex
|
||||||
* (Required) The index of the first item included in this div.
|
* (Required) The index of the first item included in this div.
|
||||||
* @param lastItemIndex
|
* @param lastItemIndex
|
||||||
@@ -343,7 +343,7 @@ public class Division extends AbstractWingElement implements StructuralElement,
|
|||||||
* masked page paradigm.
|
* masked page paradigm.
|
||||||
*
|
*
|
||||||
* @param itemsTotal
|
* @param itemsTotal
|
||||||
* (Required) How many items exist accross all paginated divs.
|
* (Required) How many items exist across all paginated divs.
|
||||||
* @param firstItemIndex
|
* @param firstItemIndex
|
||||||
* (Required) The index of the first item included in this div.
|
* (Required) The index of the first item included in this div.
|
||||||
* @param lastItemIndex
|
* @param lastItemIndex
|
||||||
@@ -354,7 +354,7 @@ public class Division extends AbstractWingElement implements StructuralElement,
|
|||||||
* @param pagesTotal
|
* @param pagesTotal
|
||||||
* (Required) How many pages the paginated div spans.
|
* (Required) How many pages the paginated div spans.
|
||||||
* @param pageURLMask
|
* @param pageURLMask
|
||||||
* (Required) The mask of a url to a particular within the
|
* (Required) The mask of a URL to a particular within the
|
||||||
* paginated set. The destination page's number should replace
|
* paginated set. The destination page's number should replace
|
||||||
* the {pageNum} string in the URL mask to generate a full URL to
|
* the {pageNum} string in the URL mask to generate a full URL to
|
||||||
* that page.
|
* that page.
|
||||||
@@ -374,9 +374,6 @@ public class Division extends AbstractWingElement implements StructuralElement,
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the head element which is the label associated with this division.
|
* Set the head element which is the label associated with this division.
|
||||||
*
|
|
||||||
* @param characters
|
|
||||||
* (May be null) Unprocessed characters to be included
|
|
||||||
*/
|
*/
|
||||||
public Head setHead() throws WingException
|
public Head setHead() throws WingException
|
||||||
{
|
{
|
||||||
@@ -475,7 +472,7 @@ public class Division extends AbstractWingElement implements StructuralElement,
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Add an interactive sub division for further logical grouping of content
|
* Add an interactive sub division for further logical grouping of content
|
||||||
* without specifing special rendering instructions.
|
* without specifying special rendering instructions.
|
||||||
*
|
*
|
||||||
* The valid values for method may be found in the static variable METHODS.
|
* The valid values for method may be found in the static variable METHODS.
|
||||||
*
|
*
|
||||||
@@ -664,7 +661,7 @@ public class Division extends AbstractWingElement implements StructuralElement,
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add a reference set for metadata refrences.
|
* Add a reference set for metadata references.
|
||||||
*
|
*
|
||||||
* @param name
|
* @param name
|
||||||
* (Required) a local identifier used to differentiate the
|
* (Required) a local identifier used to differentiate the
|
||||||
@@ -686,18 +683,13 @@ public class Division extends AbstractWingElement implements StructuralElement,
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add a reference set for metadata refrences.
|
* Add a reference set for metadata references.
|
||||||
*
|
*
|
||||||
* @param name
|
* @param name
|
||||||
* (Required) a local identifier used to differentiate the
|
* (Required) a local identifier used to differentiate the
|
||||||
* element from its siblings.
|
* element from its siblings.
|
||||||
* @param type
|
* @param type
|
||||||
* (Required) The include type, see IncludeSet.TYPES
|
* (Required) The include type, see IncludeSet.TYPES
|
||||||
* @param orderBy
|
|
||||||
* (May be null) An statement of ordering within the include set.
|
|
||||||
* @param rend
|
|
||||||
* (May be null) a rendering hint used to override the default
|
|
||||||
* display of the element.
|
|
||||||
*/
|
*/
|
||||||
public ReferenceSet addReferenceSet(String name, String type)
|
public ReferenceSet addReferenceSet(String name, String type)
|
||||||
throws WingException
|
throws WingException
|
||||||
|
@@ -241,7 +241,7 @@ public abstract class Field extends AbstractWingElement implements
|
|||||||
* Set this field to either be required or not required as determined by the
|
* Set this field to either be required or not required as determined by the
|
||||||
* required parameter.
|
* required parameter.
|
||||||
*
|
*
|
||||||
* @param requeired
|
* @param required
|
||||||
* Determine if the field is required or not.
|
* Determine if the field is required or not.
|
||||||
*/
|
*/
|
||||||
public void setRequired(boolean required)
|
public void setRequired(boolean required)
|
||||||
@@ -325,7 +325,7 @@ public abstract class Field extends AbstractWingElement implements
|
|||||||
* Set the kind of UI presentation requested for this choice, e.g.
|
* Set the kind of UI presentation requested for this choice, e.g.
|
||||||
* select vs. suggest. Value must match one of the PRESENTATIONS.
|
* select vs. suggest. Value must match one of the PRESENTATIONS.
|
||||||
*
|
*
|
||||||
* @param fieldKey pre-determined metadata field key
|
* @param value pre-determined metadata field key
|
||||||
*/
|
*/
|
||||||
public void setChoicesPresentation(String value)
|
public void setChoicesPresentation(String value)
|
||||||
throws WingException
|
throws WingException
|
||||||
|
@@ -80,7 +80,7 @@ public class Figure extends TextContainer implements StructuralElement
|
|||||||
*
|
*
|
||||||
* @param context
|
* @param context
|
||||||
* (Required) The context this element is contained in
|
* (Required) The context this element is contained in
|
||||||
* @param Source
|
* @param source
|
||||||
* (Required) The figure's image source.
|
* (Required) The figure's image source.
|
||||||
* @param target
|
* @param target
|
||||||
* (May be null) The figure's external reference, if present then
|
* (May be null) The figure's external reference, if present then
|
||||||
|
@@ -84,9 +84,6 @@ public class Hidden extends Field
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the raw value of the field removing any previous raw values.
|
* Set the raw value of the field removing any previous raw values.
|
||||||
*
|
|
||||||
* @param characters
|
|
||||||
* (May be null) Field value as a string
|
|
||||||
*/
|
*/
|
||||||
public Value setValue() throws WingException
|
public Value setValue() throws WingException
|
||||||
{
|
{
|
||||||
@@ -111,8 +108,8 @@ public class Hidden extends Field
|
|||||||
/**
|
/**
|
||||||
* Set the raw value of the field removing any previous raw values.
|
* Set the raw value of the field removing any previous raw values.
|
||||||
*
|
*
|
||||||
* @param integere
|
* @param integer
|
||||||
* (May be null) Field value as a string
|
* Field value as an integer
|
||||||
*/
|
*/
|
||||||
public void setValue(int integer) throws WingException
|
public void setValue(int integer) throws WingException
|
||||||
{
|
{
|
||||||
|
@@ -79,9 +79,6 @@ public class Instance extends Container
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the raw value of the field removing any previous raw values.
|
* Set the raw value of the field removing any previous raw values.
|
||||||
*
|
|
||||||
* @param characters
|
|
||||||
* (May be null) Field value as a string
|
|
||||||
*/
|
*/
|
||||||
public Value setValue() throws WingException
|
public Value setValue() throws WingException
|
||||||
{
|
{
|
||||||
@@ -185,9 +182,6 @@ public class Instance extends Container
|
|||||||
/**
|
/**
|
||||||
* Set the interpreted value of the field removing any previous interpreted
|
* Set the interpreted value of the field removing any previous interpreted
|
||||||
* values.
|
* values.
|
||||||
*
|
|
||||||
* @param characters
|
|
||||||
* (May be null) Field value as a string
|
|
||||||
*/
|
*/
|
||||||
public Value setInterpretedValue() throws WingException
|
public Value setInterpretedValue() throws WingException
|
||||||
{
|
{
|
||||||
@@ -230,7 +224,7 @@ public class Instance extends Container
|
|||||||
/** ******************************************************************** */
|
/** ******************************************************************** */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add an option value, there may be many of these. These values refrence
|
* Add an option value, there may be many of these. These values reference
|
||||||
* an option all ready added to the field.
|
* an option all ready added to the field.
|
||||||
*
|
*
|
||||||
* @param option
|
* @param option
|
||||||
@@ -245,7 +239,7 @@ public class Instance extends Container
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the checkbox (or radio) value of this field. This is a parameter
|
* Set the checkbox (or radio) value of this field. This is a parameter
|
||||||
* wheather the field is selected or not along with the return string that
|
* whether the field is selected or not along with the return string that
|
||||||
* should be used with this parameter.
|
* should be used with this parameter.
|
||||||
*
|
*
|
||||||
* @param checked
|
* @param checked
|
||||||
|
@@ -174,10 +174,6 @@ public class List extends AbstractWingElement implements WingMergeableElement,
|
|||||||
* Set the head element which is the label associated with this list. This
|
* Set the head element which is the label associated with this list. This
|
||||||
* method should be called before any other elements have been added to the
|
* method should be called before any other elements have been added to the
|
||||||
* list.
|
* list.
|
||||||
*
|
|
||||||
* @param characters
|
|
||||||
* (May be null) Untranslated character data to be included as
|
|
||||||
* the list's head.
|
|
||||||
*/
|
*/
|
||||||
public Head setHead() throws WingException
|
public Head setHead() throws WingException
|
||||||
{
|
{
|
||||||
|
@@ -39,8 +39,8 @@
|
|||||||
package org.dspace.app.xmlui.wing.element;
|
package org.dspace.app.xmlui.wing.element;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A class represented parameters to fields. The parameter element is basicaly a
|
* A class represented parameters to fields. The parameter element is basically a
|
||||||
* grab bag of attributes associated with varios fields.
|
* grab bag of attributes associated with various fields.
|
||||||
*
|
*
|
||||||
* @author Scott Phillips
|
* @author Scott Phillips
|
||||||
*/
|
*/
|
||||||
@@ -314,7 +314,7 @@ public class Params extends AbstractWingElement implements StructuralElement
|
|||||||
* Set the kind of UI presentation requested for this choice, e.g.
|
* Set the kind of UI presentation requested for this choice, e.g.
|
||||||
* select vs. suggest. Value must match one of the PRESENTATIONS.
|
* select vs. suggest. Value must match one of the PRESENTATIONS.
|
||||||
*
|
*
|
||||||
* @param fieldKey pre-determined metadata field key
|
* @param value pre-determined metadata field key
|
||||||
*/
|
*/
|
||||||
public void setChoicesPresentation(String value)
|
public void setChoicesPresentation(String value)
|
||||||
throws WingException
|
throws WingException
|
||||||
@@ -325,9 +325,9 @@ public class Params extends AbstractWingElement implements StructuralElement
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets whether choices are "closed" to teh set returned by plugin.
|
* Sets whether choices are "closed" to the set returned by plugin.
|
||||||
*
|
*
|
||||||
* @param fieldKey pre-determined metadata field key
|
* @param value pre-determined metadata field key
|
||||||
*/
|
*/
|
||||||
public void setChoicesClosed(boolean value)
|
public void setChoicesClosed(boolean value)
|
||||||
{
|
{
|
||||||
@@ -335,7 +335,7 @@ public class Params extends AbstractWingElement implements StructuralElement
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets whether choices are "closed" to teh set returned by plugin.
|
* Sets whether choices are "closed" to the set returned by plugin.
|
||||||
*/
|
*/
|
||||||
public void setChoicesClosed()
|
public void setChoicesClosed()
|
||||||
{
|
{
|
||||||
|
@@ -105,13 +105,11 @@ public class ReferenceSet extends AbstractWingElement implements
|
|||||||
* @param context
|
* @param context
|
||||||
* (Required) The context this element is contained in, such as
|
* (Required) The context this element is contained in, such as
|
||||||
* where to route SAX events and what i18n catalogue to use.
|
* where to route SAX events and what i18n catalogue to use.
|
||||||
|
* @param childreference
|
||||||
|
* Whether this is a child reference (not requiring a name).
|
||||||
* @param name
|
* @param name
|
||||||
* (May be null) a local identifier used to differentiate the
|
* (May be null) a local identifier used to differentiate the
|
||||||
* element from its siblings.
|
* element from its siblings.
|
||||||
* @param informationModel
|
|
||||||
* (May be null) The information model the enclosed objects
|
|
||||||
* follow. If no model is given then the default information
|
|
||||||
* model is used. (INFORMATION_MODEL_DEFAULT)
|
|
||||||
* @param type
|
* @param type
|
||||||
* (Required) The type of reference set which determines the level
|
* (Required) The type of reference set which determines the level
|
||||||
* of detail for the metadata rendered. See TYPES for a list of
|
* of detail for the metadata rendered. See TYPES for a list of
|
||||||
@@ -142,9 +140,6 @@ public class ReferenceSet extends AbstractWingElement implements
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the head element which is the label associated with this referenceset.
|
* Set the head element which is the label associated with this referenceset.
|
||||||
*
|
|
||||||
* @param characters
|
|
||||||
* (May be null) Unprocessed characters to be referenced
|
|
||||||
*/
|
*/
|
||||||
public Head setHead() throws WingException
|
public Head setHead() throws WingException
|
||||||
{
|
{
|
||||||
@@ -180,7 +175,7 @@ public class ReferenceSet extends AbstractWingElement implements
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add an object refrence.
|
* Add an object reference.
|
||||||
*
|
*
|
||||||
* @param object
|
* @param object
|
||||||
* (Required) The referenced object.
|
* (Required) The referenced object.
|
||||||
|
@@ -125,9 +125,6 @@ public class Table extends AbstractWingElement implements StructuralElement
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the head element which is the label associated with this table.
|
* Set the head element which is the label associated with this table.
|
||||||
*
|
|
||||||
* @param characters
|
|
||||||
* (May be null) Unprocessed characters to be included
|
|
||||||
*/
|
*/
|
||||||
public Head setHead() throws WingException
|
public Head setHead() throws WingException
|
||||||
{
|
{
|
||||||
|
@@ -130,9 +130,6 @@ public class Text extends Field
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the raw value of the field removing any previous raw values.
|
* Set the raw value of the field removing any previous raw values.
|
||||||
*
|
|
||||||
* @param characters
|
|
||||||
* (May be null) Field value as a string
|
|
||||||
*/
|
*/
|
||||||
public Value setValue() throws WingException
|
public Value setValue() throws WingException
|
||||||
{
|
{
|
||||||
|
@@ -40,7 +40,7 @@ package org.dspace.app.xmlui.wing.element;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* A class representing a text area input control. The text area control enables
|
* A class representing a text area input control. The text area control enables
|
||||||
* to user to entere muliple lines of text.
|
* to user to enter multiple lines of text.
|
||||||
*
|
*
|
||||||
* @author Scott Phillips
|
* @author Scott Phillips
|
||||||
*/
|
*/
|
||||||
@@ -94,7 +94,7 @@ public class TextArea extends Field
|
|||||||
/**
|
/**
|
||||||
* Set the maximum length of the field.
|
* Set the maximum length of the field.
|
||||||
*
|
*
|
||||||
* @param maxlength
|
* @param maxLength
|
||||||
* (May be zero for no defined value) The maximum length that the
|
* (May be zero for no defined value) The maximum length that the
|
||||||
* theme should accept for form input.
|
* theme should accept for form input.
|
||||||
*/
|
*/
|
||||||
@@ -131,9 +131,6 @@ public class TextArea extends Field
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the raw value of the field removing any previous raw values.
|
* Set the raw value of the field removing any previous raw values.
|
||||||
*
|
|
||||||
* @param characters
|
|
||||||
* (May be null) Field value as a string
|
|
||||||
*/
|
*/
|
||||||
public Value setValue() throws WingException
|
public Value setValue() throws WingException
|
||||||
{
|
{
|
||||||
|
@@ -83,8 +83,6 @@ public class UserMeta extends AbstractWingElement implements
|
|||||||
* @param context
|
* @param context
|
||||||
* (Required) The context this element is contained in, such as
|
* (Required) The context this element is contained in, such as
|
||||||
* where to route SAX events and what i18n catalogue to use.
|
* where to route SAX events and what i18n catalogue to use.
|
||||||
* @param authenticated
|
|
||||||
* (Required) Weather the user has been authenticated.
|
|
||||||
*/
|
*/
|
||||||
protected UserMeta(WingContext context) throws WingException
|
protected UserMeta(WingContext context) throws WingException
|
||||||
{
|
{
|
||||||
@@ -112,7 +110,7 @@ public class UserMeta extends AbstractWingElement implements
|
|||||||
* @param language
|
* @param language
|
||||||
* (May be null) The metadata's language
|
* (May be null) The metadata's language
|
||||||
* @param allowMultiple
|
* @param allowMultiple
|
||||||
* (Required) determine if multipe metadata element with the same
|
* (Required) determine if multiple metadata elements with the same
|
||||||
* element, qualifier and language are allowed.
|
* element, qualifier and language are allowed.
|
||||||
* @return A new metadata
|
* @return A new metadata
|
||||||
*/
|
*/
|
||||||
@@ -211,8 +209,8 @@ public class UserMeta extends AbstractWingElement implements
|
|||||||
String qName, Attributes attributes) throws SAXException,
|
String qName, Attributes attributes) throws SAXException,
|
||||||
WingException
|
WingException
|
||||||
{
|
{
|
||||||
// We don't merge our children but we do have one special optimization,
|
// We don't merge our children but we do have one special optimization:
|
||||||
// if a metadata is allready in the document and it is taged as not allowing
|
// if a metadata is already in the document and it is tagged as not allowing
|
||||||
// multiples then we do not add the new metadata to the document.
|
// multiples then we do not add the new metadata to the document.
|
||||||
|
|
||||||
if (WingConstants.DRI.URI.equals(namespace) && Metadata.E_METADATA.equals(localName))
|
if (WingConstants.DRI.URI.equals(namespace) && Metadata.E_METADATA.equals(localName))
|
||||||
@@ -253,7 +251,7 @@ public class UserMeta extends AbstractWingElement implements
|
|||||||
|
|
||||||
if ("yes".equals(mergedAuthenticated))
|
if ("yes".equals(mergedAuthenticated))
|
||||||
{
|
{
|
||||||
// The user has allready been set to authenticated.
|
// The user has already been set to authenticated.
|
||||||
// Do nothing.
|
// Do nothing.
|
||||||
}
|
}
|
||||||
else if ("no".equals(mergedAuthenticated))
|
else if ("no".equals(mergedAuthenticated))
|
||||||
|
Reference in New Issue
Block a user