org.dspace.browse

Class BrowseDAOUtilsDefault

java.lang.Object

org.dspace.browse.BrowseDAOUtilsDefault

All Implemented Interfaces:

BrowseDAOUtils

Direct Known Subclasses:

BrowseDAOUtilsOracle, BrowseDAOUtilsPostgres

public class BrowseDAOUtilsDefault
extends java.lang.Object
implements BrowseDAOUtils

Utility class for retrieving the size of the columns to be used in the browse tables, and applying truncation to the strings that will be inserted into the tables. Can be configured in dspace.cfg, with the following entries: webui.browse.value_columns.max - the maximum number of characters in 'value' columns (0 is unlimited) webui.browse.sort_columns.max - the maximum number of characters in 'sort' columns (0 is unlimited) webui.browse.value_columns.omission_mark - a string to append to truncated values that will be entered into the value columns (ie. '...') By default, the column sizes are '0' (unlimited), and no truncation is applied, EXCEPT for Oracle, where we have to truncate the columns for it to work! (in which case, both value and sort columns are by default limited to 2000 characters).

Author:

Graham Triggs, Richard Jones

Field Summary

Fields

Modifier and Type	Field and Description
int	sortColumnMaxChars Maximum number of characters for sort columns
int	valueColumnMaxChars Maximum number of characters for value columns
java.lang.String	valueColumnOmissionMark string to insert where omissions have been made

Constructor Summary

Constructors

Constructor and Description
BrowseDAOUtilsDefault() Create a new instance of the Default set of utils to use with the database.

Method Summary

Methods

Modifier and Type	Method and Description
int	getSortColumnMaxChars() Get the size to use for the sort columns in characters
int	getValueColumnMaxChars() Get the size to use for the 'value' columns in characters
java.lang.String	truncateSortValue(java.lang.String value) Truncate strings that are to be used for sorting
java.lang.String	truncateSortValue(java.lang.String value, int chars) Deprecated.
java.lang.String	truncateValue(java.lang.String value) Truncate strings that are to be used for the 'value' columns
java.lang.String	truncateValue(java.lang.String value, int chars) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

valueColumnMaxChars

public int valueColumnMaxChars

Maximum number of characters for value columns

sortColumnMaxChars

public int sortColumnMaxChars

Maximum number of characters for sort columns

valueColumnOmissionMark

public java.lang.String valueColumnOmissionMark

string to insert where omissions have been made

Constructor Detail

BrowseDAOUtilsDefault

public BrowseDAOUtilsDefault()

Create a new instance of the Default set of utils to use with the database. This represents the most likely case with a database, in that it does not require the fields to be truncated. Other databases, such as Oracle, require a set limit for their VARCHAR fields, and will therefore have a slightly different implementation Other database implementations should extend this class for typing and future proofing purposes

Method Detail

getValueColumnMaxChars

public int getValueColumnMaxChars()

Get the size to use for the 'value' columns in characters

Specified by:

getValueColumnMaxChars in interface BrowseDAOUtils

getSortColumnMaxChars

public int getSortColumnMaxChars()

Get the size to use for the sort columns in characters

Specified by:

getSortColumnMaxChars in interface BrowseDAOUtils

truncateValue

public java.lang.String truncateValue(java.lang.String value)

Truncate strings that are to be used for the 'value' columns

Specified by:

truncateValue in interface BrowseDAOUtils

Parameters:

value -

Returns:

the truncated value.

truncateSortValue

public java.lang.String truncateSortValue(java.lang.String value)

Truncate strings that are to be used for sorting

Specified by:

truncateSortValue in interface BrowseDAOUtils

Parameters:

value -

Returns:

the truncated value.

truncateValue

public java.lang.String truncateValue(java.lang.String value,
                             int chars)

Deprecated.

Truncate strings that are to be used for the 'value' columns. Characters is the maximum number of characters to allow. Actual truncation applied will be the SMALLER of the passed value, or that read from the configuration.

Specified by:

truncateValue in interface BrowseDAOUtils

Parameters:

value -

chars -

Returns:

the truncated value.

truncateSortValue

public java.lang.String truncateSortValue(java.lang.String value,
                                 int chars)

Deprecated.

Truncate strings that are to be used for the sorting Characters is the maximum number of characters to allow. Actual truncation applied will be the SMALLER of the passed value, or that read from the configuration.

Specified by:

truncateSortValue in interface BrowseDAOUtils

Parameters:

value -

chars -

Returns:

the truncated value.