edu.indiana.dde.mylead.common
Class MyLeadBasicContentFilter

java.lang.Object
  extended by edu.indiana.dde.mylead.common.MyLeadBasicContentFilter
All Implemented Interfaces:
MyLeadContentFilter

public class MyLeadBasicContentFilter
extends java.lang.Object
implements MyLeadContentFilter

This class is used to pass a GUIDONLY or FULL_SCHEMA content filter to a myLEAD query.


Field Summary
static int FULL_SCHEMA_CONTENT_FILTER
           
static int GUIDONLY_CONTENT_FILTER
           
 
Constructor Summary
MyLeadBasicContentFilter()
          Default constructor for an instance of myLeadBasicContentFilter.
MyLeadBasicContentFilter(int filter)
          This version of the myLeadBasicContentFilter constructor takes an integer parameter that is the filter type.
 
Method Summary
 boolean isGuidFilter()
           
 boolean isSchemaFilter()
           
 void setFilter(int filter)
          Sets the type of content filter to GUIDONLY (1) or FULL_SCHEMA (2) based on the integer passed as a parameter.
 java.lang.String wrapFilter()
          This routine wraps up the filter and returns a string that can then be used in a myLEAD query definition to create an OGSA-DAI perform document for the query.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GUIDONLY_CONTENT_FILTER

public static final int GUIDONLY_CONTENT_FILTER
See Also:
Constant Field Values

FULL_SCHEMA_CONTENT_FILTER

public static final int FULL_SCHEMA_CONTENT_FILTER
See Also:
Constant Field Values
Constructor Detail

MyLeadBasicContentFilter

public MyLeadBasicContentFilter()
Default constructor for an instance of myLeadBasicContentFilter.


MyLeadBasicContentFilter

public MyLeadBasicContentFilter(int filter)
This version of the myLeadBasicContentFilter constructor takes an integer parameter that is the filter type. If an invalid value is passed, then the filter will be set to the GUIDONLY default.

Parameters:
filter - int that matches one of the constants for a filter type: GUIDONLY_CONTENT_FILTER or FULL_SCHEMA_CONTENT_FILTER
Method Detail

setFilter

public void setFilter(int filter)
Sets the type of content filter to GUIDONLY (1) or FULL_SCHEMA (2) based on the integer passed as a parameter. If the value of the parameter is not a valid filter type, then the current setting is not changed. This class has two public constants that can be used:
GUIDONLY_CONTENT_FILTER
FULL_SCHEMA_CONTENT_FILTER

Parameters:
filter - int with the type for the filter

isGuidFilter

public boolean isGuidFilter()

isSchemaFilter

public boolean isSchemaFilter()

wrapFilter

public java.lang.String wrapFilter()
This routine wraps up the filter and returns a string that can then be used in a myLEAD query definition to create an OGSA-DAI perform document for the query.

Specified by:
wrapFilter in interface MyLeadContentFilter
Returns:
String that wraps the filter in an XML fragment