Undo overzealous reindentation.

I went overboard while trying to make things more readable.  That can
wait for another time.  Some minor rewrapping, punctuation, etc. of
comments stands.
This commit is contained in:
Mark H. Wood
2012-11-05 15:26:24 -05:00
parent 96b39c81af
commit 96a577dbfd
14 changed files with 5222 additions and 1391 deletions

View File

@@ -375,12 +375,10 @@ public class MetadataUtilities {
} }
/** /**
* rewrite of ItemImport's functionality * Rewrite of ItemImport's functionality
* but just the parsing of the file, not the processing of its elements. * but just the parsing of the file, not the processing of its elements.
* *
* @param f file of item metadata. * @validate flag to verify matching files in tree
* @validate flag to verify matching files in tree.
* @return parsed content of {@code f}.
*/ */
public static List<ContentsEntry> readContentsFile(File f) public static List<ContentsEntry> readContentsFile(File f)
throws FileNotFoundException, IOException, ParseException throws FileNotFoundException, IOException, ParseException
@@ -503,8 +501,8 @@ public class MetadataUtilities {
} }
/** /**
* Parses metadata field given in the form "<schema>.<element>[.<qualifier>|.*]". * Parses metadata field given in the form <schema>.<element>[.<qualifier>|.*]
* Checks for correct number of elements (2 or 3) and for empty strings. * checks for correct number of elements (2 or 3) and for empty strings
* *
* @return String Array * @return String Array
* @throws ParseException if validity checks fail * @throws ParseException if validity checks fail

View File

@@ -75,7 +75,7 @@ public final class BrowseIndex
} }
/** /**
* Constructor for creating generic / internal index objects. * Constructor for creating generic / internal index objects
* @param baseName The base of the table name * @param baseName The base of the table name
*/ */
private BrowseIndex(String baseName) private BrowseIndex(String baseName)
@@ -369,6 +369,7 @@ public final class BrowseIndex
* @param baseName * @param baseName
* @param isDistinct * @param isDistinct
* @param isMap * @param isMap
* @return
*/ */
private static String getSequenceName(String baseName, boolean isDistinct, boolean isMap) private static String getSequenceName(String baseName, boolean isDistinct, boolean isMap)
{ {
@@ -411,7 +412,7 @@ public final class BrowseIndex
* @param isCollection * @param isCollection
* @param isDistinct * @param isDistinct
* @param isMap * @param isMap
* @return the name of the table. * @return
*/ */
private static String getTableName(String baseName, boolean isCommunity, boolean isCollection, boolean isDistinct, boolean isMap) private static String getTableName(String baseName, boolean isCommunity, boolean isCollection, boolean isDistinct, boolean isMap)
{ {
@@ -442,7 +443,7 @@ public final class BrowseIndex
} }
/** /**
* Get the name of the table in the given circumstances. * Get the name of the table in the given circumstances
* *
* @param isCommunity whether this is a community constrained index (view) * @param isCommunity whether this is a community constrained index (view)
* @param isCollection whether this is a collection constrained index (view) * @param isCollection whether this is a collection constrained index (view)
@@ -484,8 +485,6 @@ public final class BrowseIndex
* <code> * <code>
* getTableName(false, false, false, false); * getTableName(false, false, false, false);
* </code> * </code>
*
* @return the name of the table.
*/ */
public String getTableName() public String getTableName()
{ {
@@ -493,7 +492,7 @@ public final class BrowseIndex
} }
/** /**
* Get the table name for the given set of circumstances * Get the table name for the given set of circumstances.
* *
* This is the same as calling: * This is the same as calling:
* *
@@ -504,7 +503,6 @@ public final class BrowseIndex
* @param isDistinct is this a distinct table * @param isDistinct is this a distinct table
* @param isCommunity * @param isCommunity
* @param isCollection * @param isCollection
* @return the name of the table.
* @deprecated 1.5 * @deprecated 1.5
*/ */
public String getTableName(boolean isDistinct, boolean isCommunity, boolean isCollection) public String getTableName(boolean isDistinct, boolean isCommunity, boolean isCollection)
@@ -518,8 +516,6 @@ public final class BrowseIndex
* <code> * <code>
* getTableName(false, false, false, true); * getTableName(false, false, false, true);
* </code> * </code>
*
* @return the name of the table.
*/ */
public String getMapTableName() public String getMapTableName()
{ {
@@ -532,8 +528,6 @@ public final class BrowseIndex
* <code> * <code>
* getTableName(false, false, true, false); * getTableName(false, false, true, false);
* </code> * </code>
*
* @return the name of the table.
*/ */
public String getDistinctTableName() public String getDistinctTableName()
{ {
@@ -629,7 +623,6 @@ public final class BrowseIndex
/** /**
* Get the field for sorting associated with this index. * Get the field for sorting associated with this index.
* @return the name of the field.
* @throws BrowseException * @throws BrowseException
*/ */
public String getSortField(boolean isSecondLevel) throws BrowseException public String getSortField(boolean isSecondLevel) throws BrowseException
@@ -655,11 +648,7 @@ public final class BrowseIndex
} }
/** /**
* Get an array of the names of all the browse index tables in the current
* configuration.
*
* @deprecated * @deprecated
* @return names of all the current browse index tables.
* @throws BrowseException * @throws BrowseException
*/ */
public static String[] tables() public static String[] tables()
@@ -730,10 +719,9 @@ public final class BrowseIndex
} }
/** /**
* Get the configured browse index that is defined to use this sort option * Get the configured browse index that is defined to use this sort option.
* *
* @param so * @param so
* @return the associated BrowseIndex.
* @throws BrowseException * @throws BrowseException
*/ */
public static BrowseIndex getBrowseIndex(SortOption so) throws BrowseException public static BrowseIndex getBrowseIndex(SortOption so) throws BrowseException

View File

@@ -160,7 +160,6 @@ public class BrowseItem extends DSpaceObject
/** /**
* @deprecated * @deprecated
* @param real * @param real
* @return real type, or Constants.ITEM.
*/ */
public int getType(boolean real) public int getType(boolean real)
{ {

View File

@@ -26,7 +26,7 @@ public class CrossLinks
private Map<String, String> links = new HashMap<String, String>(); private Map<String, String> links = new HashMap<String, String>();
/** /**
* Construct a new object which will obtain the configuration for itself * Construct a new object which will obtain the configuration for itself.
* *
* @throws BrowseException * @throws BrowseException
*/ */
@@ -54,8 +54,7 @@ public class CrossLinks
} }
/** /**
* Is there a link for the given canonical form of metadata (i.e. * Is there a link for the given canonical form of metadata (i.e. schema.element.qualifier)?
* schema.element.qualifier)?
* *
* @param metadata the metadata to check for a link on * @param metadata the metadata to check for a link on
*/ */
@@ -65,7 +64,7 @@ public class CrossLinks
} }
/** /**
* get the type of link that the bit of metadata has. * Get the type of link that the bit of metadata has.
* *
* @param metadata the metadata to get the link type for * @param metadata the metadata to get the link type for
*/ */

View File

@@ -599,7 +599,6 @@ public class IndexBrowse
* remove all the indices for the given item * remove all the indices for the given item
* *
* @param item the item to be removed * @param item the item to be removed
* @return true if removed.
* @throws BrowseException * @throws BrowseException
*/ */
public boolean itemRemoved(Item item) public boolean itemRemoved(Item item)

View File

@@ -48,10 +48,9 @@ public interface ItemCountDAO
public void collectionCount(Collection collection, int count) throws ItemCountException; public void collectionCount(Collection collection, int count) throws ItemCountException;
/** /**
* Get the number of items in the given DSpaceObject container. * Get the number of items in the given DSpaceObject container. This method will
* This method will only succeed if the DSpaceObject is an instance of * only succeed if the DSpaceObject is an instance of either a Community or a
* either a Community or a Collection. Otherwise it will throw an * Collection. Otherwise it will throw an exception.
* exception.
* *
* @param dso * @param dso
* @throws ItemCountException * @throws ItemCountException

View File

@@ -155,7 +155,7 @@ public class ItemCountDAOOracle implements ItemCountDAO
} }
/** /**
* get the count of the items in the given container. * Get the count of the items in the given container.
* *
* @param dso * @param dso
* @throws ItemCountException * @throws ItemCountException
@@ -289,6 +289,7 @@ public class ItemCountDAOOracle implements ItemCountDAO
* get the count for the given community * get the count for the given community
* *
* @param community * @param community
* @return
* @throws ItemCountException * @throws ItemCountException
*/ */
private int getCommunityCount(Community community) private int getCommunityCount(Community community)

View File

@@ -155,7 +155,7 @@ public class ItemCountDAOPostgres implements ItemCountDAO
} }
/** /**
* get the count of the items in the given container * Get the count of the items in the given container.
* *
* @param dso * @param dso
* @throws ItemCountException * @throws ItemCountException
@@ -245,6 +245,7 @@ public class ItemCountDAOPostgres implements ItemCountDAO
* Get the count for the given collection * Get the count for the given collection
* *
* @param collection * @param collection
* @return
* @throws ItemCountException * @throws ItemCountException
*/ */
private int getCollectionCount(Collection collection) private int getCollectionCount(Collection collection)
@@ -288,6 +289,7 @@ public class ItemCountDAOPostgres implements ItemCountDAO
* get the count for the given community * get the count for the given community
* *
* @param community * @param community
* @return
* @throws ItemCountException * @throws ItemCountException
*/ */
private int getCommunityCount(Community community) private int getCommunityCount(Community community)

View File

@@ -66,6 +66,7 @@ public class ItemCounter
*/ */
public ItemCounter(Context context) public ItemCounter(Context context)
throws ItemCountException throws ItemCountException
{ {
this.context = context; this.context = context;
this.dao = ItemCountDAOFactory.getInstance(this.context); this.dao = ItemCountDAOFactory.getInstance(this.context);
@@ -100,7 +101,7 @@ public class ItemCounter
* Get the count of the items in the given container. If the configuration * Get the count of the items in the given container. If the configuration
* value webui.strengths.cache is equal to 'true' this will return the * value webui.strengths.cache is equal to 'true' this will return the
* cached value if it exists. If it is equal to 'false' it will count * cached value if it exists. If it is equal to 'false' it will count
* the number of items in the container in real time * the number of items in the container in real time.
* *
* @param dso * @param dso
* @throws ItemCountException * @throws ItemCountException

View File

@@ -95,7 +95,7 @@ public class ItemListConfig
} }
/** /**
* what metadata is to go in the given column number * What metadata is to go in the given column number?
* *
* @param col * @param col
*/ */

View File

@@ -43,13 +43,13 @@ public class HarvestedCollection
/* /*
* collection_id | integer | not null * collection_id | integer | not null
* harvest_type | integer | harvest_type | integer |
* oai_source | text | oai_source | text |
* oai_set_id | text | oai_set_id | text |
* harvest_message | text | harvest_message | text |
* metadata_config_id | text | metadata_config_id | text |
* harvest_status | integer | harvest_status | integer |
* harvest_start_time | timestamp with time zone | harvest_start_time | timestamp with time zone |
*/ */
// TODO: make sure this guy knows to lock people out if the status is not zero. // TODO: make sure this guy knows to lock people out if the status is not zero.
@@ -212,10 +212,9 @@ 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 matching Collection IDs.
* @throws SQLException * @throws SQLException
*/ */
public static List<Integer> findByStatus(Context c, int status) throws SQLException { public static List<Integer> findByStatus(Context c, int status) throws SQLException {

3846
mvn.out Normal file

File diff suppressed because it is too large Load Diff