com.esri.aims.mtier.model.metadata.query
Class Browse

java.lang.Object
  com.esri.aims.mtier.model.metadata.query.Browse

All Implemented Interfaces:

Serializable

public class Browse
extends Object
implements Serializable

This class supports metadata search functionality.

See Also:

Serialized Form

Field Summary

static int	ANCESTOR_TYPE
static int	AND_OPERATOR
static int	CHILD_TYPE
static int	CONTENTTYPE_SORT
static int	DATE_SORT
static int	DESCENDANT_TYPE
static int	DOCUMENT
static int	GLOBALAREA_SORT
static int	LOCALAREA_SORT
static int	NAME_SORT
static int	NONE
static int	OR_OPERATOR
static int	PARENT_TYPE
static int	RELEVANCE_SORT
static int	SEARCH
static int	SIBLING_TYPE
static int	UNKNOWN_TYPE
static int	XOR_OPERATOR

Constructor Summary

Browse()

Method Summary

Vector	getCollectionInfoValues(CollectionInfo collInfo) Gets the CollectionInfo for a given metadata dataset.
ConnectionProxy	getConnectionProxy() Returns the ConnectionProxy object associated with this object.
boolean	getContentInfoValidation() Returns true if CONTENT_INFO is returned as valid, false otherwise.
DatasetCollection	getDeletedDocuments(String before, String after) Returns deleted documents
List	getDeletedRelationships() Returns deleted relationships
int	getFolderMask() Returns the FolderMask associated with this object.
boolean	getFullOutput() Returns the fulloutput
int	getGndextent() Returns the constant that defines the gndextent.
String	getGndextentString() Returns the string value of the gndextent.
int	getMaxResults() Returns the maximum number of results that can be returned by the server.
Dataset	getMetadataDocument(String docid) Returns dataset associated with this docid.
int	getOperator() Returns the operator value.
String	getOperatorString() Returns the string value of the operator.
List	getRelationships() Returns relationships
int	getRelationshipType() Returns the relationship type associated with this object.
String	getRelationshipTypeString() Returns the relationship type associated with this object as an user-readable string.
Dataset	getRootDataset() Returns the root dataset of a metadata database.
int	getSort() Returns the constant that defines the sort type before batching.
int	getSort2() Returns the constant that defines the sort type after batching.
String	getSort2String() Returns the String value of the sort type used after batching.
String	getSortString() Returns the String value of the sort type used before batching.
int	getStartResults() Returns the previously set value for StartResults.
static String	getStringFromType(int newType) Returns the String value of the relationship type.
DatasetCollection	getSubset(Dataset dataset) Returns the subsets the given dataset.
boolean	getThumbnail() Gets the thumbnail flag
String	getUpdatedAfter() Returns the updated afer value.
String	getUpdatedBefore() Returns the updated before value.
List	getUsers() Get the user names
void	setConnectionProxy(ConnectionProxy conProx) Sets the given ConnectionProxy object to connect to an ArcIMS Server.
void	setFolderMask(int newFolderMask) Sets the FolderMask with given integer value.
void	setFullOutput(boolean fulloutput) Sets the fulloutput
void	setGndextent(int gndextentValue) Sets the gndextent
void	setMaxResults(int newMaxResults) Sets the maximum number of results returned by the server.
void	setOperator(int newOperator) Sets the operator with given value.
void	setRelationshipType(int relationshipType) Sets the relationship type for this object.
void	setSort(int sortValue) Sets the sort type used to sort the results before batching.
void	setSort2(int sortValue) Set the sort type used to sort the results after batching.
void	setStartResults(int newStartResults) Sets the given value as StartResults.
void	setThumbnail(boolean thumbnail) Sets the thumbnail flag
void	setUpdatedAfter(String updated) Sets the updated after value.
void	setUpdatedBefore(String updated) Sets the updated before value.

Methods inherited from class java.lang.Object

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

Field Detail

AND_OPERATOR

public static final int AND_OPERATOR

See Also:

Constant Field Values

OR_OPERATOR

public static final int OR_OPERATOR

See Also:

Constant Field Values

XOR_OPERATOR

public static final int XOR_OPERATOR

See Also:

Constant Field Values

NAME_SORT

public static final int NAME_SORT

See Also:

Constant Field Values

RELEVANCE_SORT

public static final int RELEVANCE_SORT

See Also:

Constant Field Values

CONTENTTYPE_SORT

public static final int CONTENTTYPE_SORT

See Also:

Constant Field Values

LOCALAREA_SORT

public static final int LOCALAREA_SORT

See Also:

Constant Field Values

GLOBALAREA_SORT

public static final int GLOBALAREA_SORT

See Also:

Constant Field Values

DATE_SORT

public static final int DATE_SORT

See Also:

Constant Field Values

CHILD_TYPE

public static final int CHILD_TYPE

See Also:

Constant Field Values

PARENT_TYPE

public static final int PARENT_TYPE

See Also:

Constant Field Values

SIBLING_TYPE

public static final int SIBLING_TYPE

See Also:

Constant Field Values

ANCESTOR_TYPE

public static final int ANCESTOR_TYPE

See Also:

Constant Field Values

DESCENDANT_TYPE

public static final int DESCENDANT_TYPE

See Also:

Constant Field Values

UNKNOWN_TYPE

public static final int UNKNOWN_TYPE

See Also:

Constant Field Values

NONE

public static final int NONE

See Also:

Constant Field Values

DOCUMENT

public static final int DOCUMENT

See Also:

Constant Field Values

SEARCH

public static final int SEARCH

See Also:

Constant Field Values

Constructor Detail

Browse

public Browse()

Method Detail

setConnectionProxy

public void setConnectionProxy(ConnectionProxy conProx)

Sets the given ConnectionProxy object to connect to an ArcIMS Server.

getConnectionProxy

public ConnectionProxy getConnectionProxy()

Returns the ConnectionProxy object associated with this object.

setMaxResults

public void setMaxResults(int newMaxResults)

Sets the maximum number of results returned by the server.

getMaxResults

public int getMaxResults()

Returns the maximum number of results that can be returned by the server.

setStartResults

public void setStartResults(int newStartResults)

Sets the given value as StartResults.

getStartResults

public int getStartResults()

Returns the previously set value for StartResults.

setFolderMask

public void setFolderMask(int newFolderMask)

Sets the FolderMask with given integer value.

getFolderMask

public int getFolderMask()

Returns the FolderMask associated with this object.

setOperator

public void setOperator(int newOperator)

Sets the operator with given value.

Parameters:

newOperator - the new operator to set.

getOperator

public int getOperator()

Returns the operator value.

Returns:

int returns.

getOperatorString

public String getOperatorString()

Returns the string value of the operator.

setSort

public void setSort(int sortValue)

Sets the sort type used to sort the results before batching.

Parameters:

sortValue -

getSort

public int getSort()

Returns the constant that defines the sort type before batching.

Returns:

an integer value

getSortString

public String getSortString()

Returns the String value of the sort type used before batching.

setSort2

public void setSort2(int sortValue)

Set the sort type used to sort the results after batching.

Parameters:

sortValue - the sortValue as an integer

getSort2

public int getSort2()

Returns the constant that defines the sort type after batching.

Returns:

an integer value

getSort2String

public String getSort2String()

Returns the String value of the sort type used after batching.

setGndextent

public void setGndextent(int gndextentValue)

Sets the gndextent

Parameters:

gndextentValue -

getGndextent

public int getGndextent()

Returns the constant that defines the gndextent.

Returns:

an integer

getGndextentString

public String getGndextentString()

Returns the string value of the gndextent.

Returns:

String

setFullOutput

public void setFullOutput(boolean fulloutput)

Sets the fulloutput

Parameters:

fulloutput -

getFullOutput

public boolean getFullOutput()

Returns the fulloutput

Returns:

an boolean

getThumbnail

public boolean getThumbnail()

Gets the thumbnail flag

Returns:

boolean

setThumbnail

public void setThumbnail(boolean thumbnail)

Sets the thumbnail flag

Parameters:

thumbnail -

setRelationshipType

public void setRelationshipType(int relationshipType)

Sets the relationship type for this object.

Parameters:

relationshipType - an integer that defines relationship as ANCESTOR_TYPE, CHILD_TYPE, DESCENDENT_TYPE, PARENT_TYPE, SIBLING_TYPE, or as UNKNOWN_TYPE.

getRelationshipType

public int getRelationshipType()

Returns the relationship type associated with this object.

Returns:

an integer that defines relationship as ANCESTOR_TYPE, CHILD_TYPE, DESCENDENT_TYPE, PARENT_TYPE, SIBLING_TYPE, or as UNKNOWN_TYPE.

getRelationshipTypeString

public String getRelationshipTypeString()

Returns the relationship type associated with this object as an user-readable string.

setUpdatedAfter

public void setUpdatedAfter(String updated)

Sets the updated after value.

getUpdatedAfter

public String getUpdatedAfter()

Returns the updated afer value.

setUpdatedBefore

public void setUpdatedBefore(String updated)

Sets the updated before value.

getUpdatedBefore

public String getUpdatedBefore()

Returns the updated before value.

getRootDataset

public Dataset getRootDataset()
                       throws com.esri.aims.mtier.model.axl.AXLAttributeException,
                              ConnectionParameterException,
                              com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                              AuthenticationException,
                              SAXException,
                              IOException

Returns the root dataset of a metadata database.

Throws:

com.esri.aims.mtier.model.axl.AXLAttributeException

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

SAXException

IOException

getSubset

public DatasetCollection getSubset(Dataset dataset)
                            throws com.esri.aims.mtier.model.axl.AXLAttributeException,
                                   ConnectionParameterException,
                                   com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                   AuthenticationException,
                                   SAXException,
                                   IOException

Returns the subsets the given dataset.

Throws:

com.esri.aims.mtier.model.axl.AXLAttributeException

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

SAXException

IOException

getMetadataDocument

public Dataset getMetadataDocument(String docid)
                            throws com.esri.aims.mtier.model.axl.AXLAttributeException,
                                   ConnectionParameterException,
                                   com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                   AuthenticationException,
                                   SAXException,
                                   IOException

Returns dataset associated with this docid.

Throws:

com.esri.aims.mtier.model.axl.AXLAttributeException

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

SAXException

IOException

getCollectionInfoValues

public Vector getCollectionInfoValues(CollectionInfo collInfo)
                               throws com.esri.aims.mtier.model.axl.AXLAttributeException,
                                      ConnectionParameterException,
                                      com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                      AuthenticationException,
                                      SAXException,
                                      IOException

Gets the CollectionInfo for a given metadata dataset.

Throws:

com.esri.aims.mtier.model.axl.AXLAttributeException

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

SAXException

IOException

getContentInfoValidation

public boolean getContentInfoValidation()
                                 throws com.esri.aims.mtier.model.axl.AXLAttributeException,
                                        ConnectionParameterException,
                                        com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                        AuthenticationException,
                                        SAXException,
                                        IOException

Returns true if CONTENT_INFO is returned as valid, false otherwise.

Throws:

com.esri.aims.mtier.model.axl.AXLAttributeException

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

SAXException

IOException

getUsers

public List getUsers()
              throws com.esri.aims.mtier.model.axl.AXLAttributeException,
                     ConnectionParameterException,
                     com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                     AuthenticationException,
                     SAXException,
                     IOException

Get the user names

Returns:

UserCollection The metadata users.

Throws:

com.esri.aims.mtier.model.axl.AXLAttributeException

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

SAXException

IOException

getStringFromType

public static String getStringFromType(int newType)

Returns the String value of the relationship type.

getDeletedDocuments

public DatasetCollection getDeletedDocuments(String before,
                                             String after)
                                      throws com.esri.aims.mtier.model.axl.AXLAttributeException,
                                             ConnectionParameterException,
                                             com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                             AuthenticationException,
                                             SAXException,
                                             IOException

Returns deleted documents

Throws:

com.esri.aims.mtier.model.axl.AXLAttributeException

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

SAXException

IOException

getDeletedRelationships

public List getDeletedRelationships()
                             throws com.esri.aims.mtier.model.axl.AXLAttributeException,
                                    ConnectionParameterException,
                                    com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                    AuthenticationException,
                                    SAXException,
                                    IOException

Returns deleted relationships

Throws:

com.esri.aims.mtier.model.axl.AXLAttributeException

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

SAXException

IOException

getRelationships

public List getRelationships()
                      throws com.esri.aims.mtier.model.axl.AXLAttributeException,
                             ConnectionParameterException,
                             com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                             AuthenticationException,
                             SAXException,
                             IOException

Returns relationships

Throws:

com.esri.aims.mtier.model.axl.AXLAttributeException

ConnectionParameterException

com.esri.aims.mtier.io.http.UnableToPingEsrimapException

AuthenticationException

SAXException

IOException