ptdb.common.dto

Class SearchCriteria

java.lang.Object

ptdb.common.dto.SearchCriteria

public class SearchCriteria
extends java.lang.Object

DTO (Data Transfer Object) which contains all the search criteria input by the user. It is constructed by the GUI layer class to pass the search criteria.
There are three categories of criteria in this class:
1. Some attributes information of the Ptolemy model that the user wants to search on.
2. The XQuery command to be executed directly in the XML database for searching.
3. The pattern to be matched to search the model.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Alek Wang

Pt.AcceptedRating:

red (wenjiaow)

Pt.ProposedRating:

red (wenjiaow)

Constructor Summary

Constructors

Constructor and Description
SearchCriteria()

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<Attribute>	getAttributes() Get the attributes criteria from the search criteria.
DBGraphSearchCriteria	getDBGraphSearchCriteria() Get the graph search criteria from the search criteria.
java.lang.String	getModelName() Get the name of the model from the search criteria.
java.lang.String	getPatternMoML() Get the MoML of the graph pattern search criteria.
java.lang.String	getSearchCommand() Get the search command criteria from the search criteria.
void	setAttributes(java.util.ArrayList<Attribute> attributes) Set the attribute criteria for the search criteria.
void	setDBGraphSearchCriteria(DBGraphSearchCriteria dbGraphSearchCriteria) Set the graph search criteria for the search criteria.
void	setModelName(java.lang.String modelName) Set the name of the model for the search criteria.
void	setPatternMoML(java.lang.String patternMoML) Set the MoML for the graph pattern search criteria.
void	setSearchCommand(java.lang.String searchCommand) Set the XQuery search command for the search criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchCriteria

public SearchCriteria()

Method Detail

getAttributes

public java.util.ArrayList<Attribute> getAttributes()

Get the attributes criteria from the search criteria.

Returns:

All the attributes input by the user as the search criteria.

See Also:

setAttributes(java.util.ArrayList<ptolemy.kernel.util.Attribute>)

getDBGraphSearchCriteria

public DBGraphSearchCriteria getDBGraphSearchCriteria()

Get the graph search criteria from the search criteria.

Returns:

The graph search criteria input by the user.

See Also:

setDBGraphSearchCriteria(ptdb.common.dto.DBGraphSearchCriteria)

getModelName

public java.lang.String getModelName()

Get the name of the model from the search criteria.

Returns:

The model name search criteria.

See Also:

setModelName(java.lang.String)

getPatternMoML

public java.lang.String getPatternMoML()

Get the MoML of the graph pattern search criteria.

Returns:

The MoML of the pattern.

See Also:

setPatternMoML(String)

getSearchCommand

public java.lang.String getSearchCommand()

Get the search command criteria from the search criteria.

Returns:

The XQuery search command input by the user.

See Also:

setSearchCommand(java.lang.String)

setAttributes

public void setAttributes(java.util.ArrayList<Attribute> attributes)

Set the attribute criteria for the search criteria.

Parameters:

attributes - The attributes input by the user to set in the search criteria.

See Also:

getAttributes()

setDBGraphSearchCriteria

public void setDBGraphSearchCriteria(DBGraphSearchCriteria dbGraphSearchCriteria)

Set the graph search criteria for the search criteria.

Parameters:

dbGraphSearchCriteria - The graph search criteria input by the user to set in the search criteria.

See Also:

getDBGraphSearchCriteria()

setModelName

public void setModelName(java.lang.String modelName)

Set the name of the model for the search criteria.

Parameters:

modelName - The name of the model to be set in the search criteria.

See Also:

getModelName()

setPatternMoML

public void setPatternMoML(java.lang.String patternMoML)

Set the MoML for the graph pattern search criteria.

Parameters:

patternMoML - The MoMl of the pattern to be set in the search criteria.

See Also:

getPatternMoML()

setSearchCommand

public void setSearchCommand(java.lang.String searchCommand)

Set the XQuery search command for the search criteria.

Parameters:

searchCommand - The XQuery search command to set in the search criteria.

See Also:

getSearchCommand()