public final class BrowseIndex
extends java.lang.Object
| Modifier and Type | Method and Description |
|---|---|
void |
generateMdBits()
Populate the internal array containing the bits of metadata, for
ease of use later
|
static BrowseIndex |
getBrowseIndex(SortOption so)
Get the configured browse index that is defined to use this sort option.
|
static BrowseIndex |
getBrowseIndex(java.lang.String name)
Get the browse index from configuration with the specified name.
|
static BrowseIndex[] |
getBrowseIndices()
Get an array of all the browse indices for the current configuration
|
java.lang.String |
getDataType() |
java.lang.String |
getDefaultOrder() |
java.lang.String |
getDisplayType() |
java.lang.String |
getDistinctTableName()
Get the default name of the distinct table.
|
java.lang.String |
getIndexColumn()
Get the name of the primary key index column
|
static BrowseIndex |
getItemBrowseIndex()
Get the internally defined browse index for archived items.
|
java.lang.String |
getMapTableName()
Get the default name of the distinct map table.
|
java.lang.String[] |
getMdBits(int idx) |
java.lang.String |
getMetadata() |
java.lang.String |
getMetadata(int idx) |
int |
getMetadataCount() |
java.lang.String |
getName() |
static BrowseIndex |
getPrivateBrowseIndex() |
java.lang.String |
getSequenceName(boolean isDistinct,
boolean isMap)
Get the name of the sequence that will be used in the given circumstances
|
static java.lang.String |
getSequenceName(int number,
boolean isDistinct,
boolean isMap)
Get the name of the sequence that will be used in the given circumstances
|
java.lang.String |
getSortField(boolean isSecondLevel)
Get the field for sorting associated with this index.
|
SortOption |
getSortOption()
Get the SortOption associated with this index.
|
java.lang.String |
getTableName()
Get the default index table name.
|
java.lang.String |
getTableName(boolean isCommunity,
boolean isCollection)
Deprecated.
1.5
|
java.lang.String |
getTableName(boolean isDistinct,
boolean isCommunity,
boolean isCollection)
Deprecated.
1.5
|
java.lang.String |
getTableName(boolean isCommunity,
boolean isCollection,
boolean isDistinct,
boolean isMap)
Deprecated.
1.5
|
static java.lang.String |
getTableName(int number,
boolean isCommunity,
boolean isCollection,
boolean isDistinct,
boolean isMap)
Deprecated.
1.5
|
java.lang.String |
getValueColumn()
Get the name of the column that is used to store the default value column
|
static BrowseIndex |
getWithdrawnBrowseIndex()
Get the internally defined browse index for withdrawn items.
|
java.lang.String[] |
interpretField(java.lang.String mfield,
java.lang.String init)
Take a string representation of a metadata field, and return it as an array.
|
boolean |
isAuthorityIndex()
Is the browse index authority value?
|
boolean |
isDate()
Is the browse index type for a date?
|
boolean |
isDisplayFrequencies() |
boolean |
isInternalIndex()
Does this browse index represent one of the internal item indexes?
|
boolean |
isItemIndex()
Is the browse index of display type full?
|
boolean |
isMetadataIndex()
Is the browse index of display type single?
|
static java.lang.String[] |
tables()
Deprecated.
|
public java.lang.String getDefaultOrder()
public java.lang.String getDataType()
public java.lang.String getDisplayType()
public int getMetadataCount()
public java.lang.String[] getMdBits(int idx)
public java.lang.String getMetadata()
public java.lang.String getMetadata(int idx)
public java.lang.String getName()
public SortOption getSortOption()
public boolean isDisplayFrequencies()
public void generateMdBits()
public java.lang.String getSequenceName(boolean isDistinct,
boolean isMap)
isDistinct - is a distinct tableisMap - is a map tablepublic static java.lang.String getSequenceName(int number,
boolean isDistinct,
boolean isMap)
number - the index configuration numberisDistinct - is a distinct tableisMap - is a map tablepublic static java.lang.String getTableName(int number,
boolean isCommunity,
boolean isCollection,
boolean isDistinct,
boolean isMap)
number - the index configuration numberisCommunity - whether this is a community constrained index (view)isCollection - whether this is a collection constrained index (view)isDistinct - whether this is a distinct tableisMap - whether this is a distinct map tablepublic java.lang.String getTableName(boolean isCommunity,
boolean isCollection,
boolean isDistinct,
boolean isMap)
isCommunity - whether this is a community constrained index (view)isCollection - whether this is a collection constrained index (view)isDistinct - whether this is a distinct tableisMap - whether this is a distinct map tablepublic java.lang.String getTableName(boolean isCommunity,
boolean isCollection)
getTableName(isCommunity, isCollection, false, false);
isCommunity - whether this is a community constrained index (view)isCollection - whether this is a collection constrained index (view)public java.lang.String getTableName()
getTableName(false, false, false, false);
public java.lang.String getTableName(boolean isDistinct,
boolean isCommunity,
boolean isCollection)
getTableName(isCommunity, isCollection, isDistinct, false);
isDistinct - is this a distinct tableisCommunity - isCollection - public java.lang.String getMapTableName()
getTableName(false, false, false, true);
public java.lang.String getDistinctTableName()
getTableName(false, false, true, false);
public java.lang.String getValueColumn()
public java.lang.String getIndexColumn()
public boolean isDate()
public boolean isMetadataIndex()
public boolean isAuthorityIndex()
public boolean isItemIndex()
public java.lang.String getSortField(boolean isSecondLevel)
throws BrowseException
BrowseExceptionpublic static java.lang.String[] tables()
throws BrowseException
BrowseExceptionpublic static BrowseIndex[] getBrowseIndices() throws BrowseException
BrowseExceptionpublic static BrowseIndex getBrowseIndex(java.lang.String name) throws BrowseException
name - the name to retrieveBrowseExceptionpublic static BrowseIndex getBrowseIndex(SortOption so) throws BrowseException
so - BrowseExceptionpublic static BrowseIndex getItemBrowseIndex()
public static BrowseIndex getWithdrawnBrowseIndex()
public static BrowseIndex getPrivateBrowseIndex()
public java.lang.String[] interpretField(java.lang.String mfield,
java.lang.String init)
throws java.io.IOException
mfield - the string representation of the metadatainit - the default value of the array elementsjava.io.IOExceptionpublic boolean isInternalIndex()
Copyright © 2018 DuraSpace. All Rights Reserved.