org.LexGrid.LexBIG.caCore.applicationservice
Class QueryOptions

java.lang.Object
  extended by org.LexGrid.LexBIG.caCore.applicationservice.QueryOptions
All Implemented Interfaces:
Serializable

public class QueryOptions
extends Object
implements Serializable

Options to use during LexEVS Data Service Querying.

Author:
Kevin Peterson
See Also:
Serialized Form

Field Summary
private  String codingScheme
           
private  org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag codingSchemeVersionOrTag
           
private  boolean lazyLoad
           
private  int resultPageSize
           
private  HashMap securityTokens
           
 
Constructor Summary
QueryOptions()
           
 
Method Summary
 String getCodingScheme()
          Get the Coding Scheme name that this QueryOptions instance will restrict to.
 org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag getCodingSchemeVersionOrTag()
          Get the CodingSchemeVersionOrTag that this QueryOptions instance will restrict to.
 int getResultPageSize()
          The number of results to be returned to the client at one time.
 HashMap getSecurityTokens()
          Get the Security Tokens associated with this QueryOptions instance.
 boolean isLazyLoad()
          Returns whether or not the QueryOptions instance will use LazyLoading.
 void setCodingScheme(String codingScheme)
          Set the Coding Scheme name that this QueryOptions instance will restrict to.
 void setCodingSchemeVersionOrTag(org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag codingSchemeVersionOrTag)
          Set the CodingSchemeVersionOrTag that this QueryOptions instance will restrict to.
 void setLazyLoad(boolean lazyLoad)
          Sets whether or not the QueryOptions instance will use LazyLoading.
 void setResultPageSize(int resultPageSize)
          Specifies the number of results returned to the client at one time.
 void setSecurityTokens(HashMap securityTokens)
          Set the Security Tokens associated with this QueryOptions instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

codingScheme

private String codingScheme

codingSchemeVersionOrTag

private org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag codingSchemeVersionOrTag

securityTokens

private HashMap securityTokens

lazyLoad

private boolean lazyLoad

resultPageSize

private int resultPageSize
Constructor Detail

QueryOptions

public QueryOptions()
Method Detail

getSecurityTokens

public HashMap getSecurityTokens()
Get the Security Tokens associated with this QueryOptions instance.

Returns:
Security Tokens

setSecurityTokens

public void setSecurityTokens(HashMap securityTokens)
Set the Security Tokens associated with this QueryOptions instance. These Security Tokens will be applied to the Query using this QueryOptions instance and that Query alone.

Parameters:
securityTokens -

getCodingScheme

public String getCodingScheme()
Get the Coding Scheme name that this QueryOptions instance will restrict to.

Returns:
The Coding Scheme to Query

setCodingScheme

public void setCodingScheme(String codingScheme)
Set the Coding Scheme name that this QueryOptions instance will restrict to.

Parameters:
The - Coding Scheme to Query

getCodingSchemeVersionOrTag

public org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag getCodingSchemeVersionOrTag()
Get the CodingSchemeVersionOrTag that this QueryOptions instance will restrict to.

Returns:
The CodingSchemeVersionOrTag to Query

setCodingSchemeVersionOrTag

public void setCodingSchemeVersionOrTag(org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag codingSchemeVersionOrTag)
Set the CodingSchemeVersionOrTag that this QueryOptions instance will restrict to.

Parameters:
The - CodingSchemeVersionOrTag to Query

isLazyLoad

public boolean isLazyLoad()
Returns whether or not the QueryOptions instance will use LazyLoading.

Returns:
Is lazy loading enabled

setLazyLoad

public void setLazyLoad(boolean lazyLoad)
Sets whether or not the QueryOptions instance will use LazyLoading. LazyLoading means that certain associations and properties of returned Objects may not be fully populated - but request information from the server as needed. Enabling this option will speed up certain queries. NOTE: This may only be true if you have set the 'CodingScheme' property. There is no way to LazyLoad an Object without narrowing the Query down to a specific CodingScheme.

Parameters:
lazyLoad -

getResultPageSize

public int getResultPageSize()
The number of results to be returned to the client at one time.

Returns:
the result page size

setResultPageSize

public void setResultPageSize(int resultPageSize)
Specifies the number of results returned to the client at one time. If not specified, this will default to whatever the Server default page size has been set to. If this is set high, the server will return large results sets back to the client. If it is low, fewer results will be returned at a time, but more queries to the server will be made. This parameter is for specifically tweaking the page size, but and in most cases the server default will be optimal.

Parameters:
number - of results returned per page