org.LexGrid.LexBIG.DataModel.cagrid
Class GraphResolutionPolicy

java.lang.Object
  extended by org.LexGrid.LexBIG.DataModel.cagrid.GraphResolutionPolicy
All Implemented Interfaces:
java.io.Serializable

public class GraphResolutionPolicy
extends java.lang.Object
implements java.io.Serializable

Class setting policy to resolve a CodedNodeGraph

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
GraphResolutionPolicy()
           
 
Method Summary
 void addPropertyTypes(int index, PropertyType vPropertyTypes)
           
 void addPropertyTypes(PropertyType vPropertyTypes)
           
 java.util.Enumeration<PropertyType> enumeratePropertyTypes()
          Method enumeratePropertyTypes.
 LocalNameList getFilterOptions()
          Returns the value of field 'filterOptions'.
 ConceptReference getGraphFocus()
          Returns the value of field 'graphFocus'.
 java.lang.Boolean getKeeptLastAssociationUnresolved()
          Returns the value of field 'keeptLastAssociationUnresolved'.
 java.lang.Integer getMaximumToReturn()
          Returns the value of field 'maximumToReturn'.
 LocalNameList getPropertyNames()
          Returns the value of field 'propertyNames'.
 PropertyType[] getPropertyTypes()
          Method getPropertyTypes.Returns the contents of the collection in an Array.
 PropertyType getPropertyTypes(int index)
          Method getPropertyTypes.
 int getPropertyTypesCount()
          Method getPropertyTypesCount.
 java.lang.Integer getResolveAssociationDepth()
          Returns the value of field 'resolveAssociationDepth'.
 java.lang.Boolean getResolveBackwards()
          Returns the value of field 'resolveBackwards'.
 java.lang.Integer getResolveCodedEntryDepth()
          Returns the value of field 'resolveCodedEntryDepth'.
 java.lang.Boolean getResolveForward()
          Returns the value of field 'resolveForward'.
 SortOptionList getSortOptions()
          Returns the value of field 'sortOptions'.
 java.lang.Boolean isKeeptLastAssociationUnresolved()
          Returns the value of field 'keeptLastAssociationUnresolved'.
 java.lang.Boolean isResolveBackwards()
          Returns the value of field 'resolveBackwards'.
 java.lang.Boolean isResolveForward()
          Returns the value of field 'resolveForward'.
 java.util.Iterator<PropertyType> iteratePropertyTypes()
          Method iteratePropertyTypes.
 void removeAllPropertyTypes()
           
 boolean removePropertyTypes(PropertyType vPropertyTypes)
          Method removePropertyTypes.
 PropertyType removePropertyTypesAt(int index)
          Method removePropertyTypesAt.
 void setFilterOptions(LocalNameList filterOptions)
          Sets the value of field 'filterOptions'.
 void setGraphFocus(ConceptReference graphFocus)
          Sets the value of field 'graphFocus'.
 void setKeeptLastAssociationUnresolved(java.lang.Boolean keeptLastAssociationUnresolved)
          Sets the value of field 'keeptLastAssociationUnresolved'.
 void setMaximumToReturn(java.lang.Integer maximumToReturn)
          Sets the value of field 'maximumToReturn'.
 void setPropertyNames(LocalNameList propertyNames)
          Sets the value of field 'propertyNames'.
 void setPropertyTypes(int index, PropertyType vPropertyTypes)
           
 void setPropertyTypes(PropertyType[] vPropertyTypesArray)
           
 void setResolveAssociationDepth(java.lang.Integer resolveAssociationDepth)
          Sets the value of field 'resolveAssociationDepth'.
 void setResolveBackwards(java.lang.Boolean resolveBackwards)
          Sets the value of field 'resolveBackwards'.
 void setResolveCodedEntryDepth(java.lang.Integer resolveCodedEntryDepth)
          Sets the value of field 'resolveCodedEntryDepth'.
 void setResolveForward(java.lang.Boolean resolveForward)
          Sets the value of field 'resolveForward'.
 void setSortOptions(SortOptionList sortOptions)
          Sets the value of field 'sortOptions'.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GraphResolutionPolicy

public GraphResolutionPolicy()
Method Detail

addPropertyTypes

public void addPropertyTypes(PropertyType vPropertyTypes)
                      throws java.lang.IndexOutOfBoundsException
Parameters:
vPropertyTypes -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addPropertyTypes

public void addPropertyTypes(int index,
                             PropertyType vPropertyTypes)
                      throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vPropertyTypes -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumeratePropertyTypes

public java.util.Enumeration<PropertyType> enumeratePropertyTypes()
Method enumeratePropertyTypes.

Returns:
an Enumeration over all possible elements of this collection

getFilterOptions

public LocalNameList getFilterOptions()
Returns the value of field 'filterOptions'.

Returns:
the value of field 'FilterOptions'.

getGraphFocus

public ConceptReference getGraphFocus()
Returns the value of field 'graphFocus'.

Returns:
the value of field 'GraphFocus'.

getKeeptLastAssociationUnresolved

public java.lang.Boolean getKeeptLastAssociationUnresolved()
Returns the value of field 'keeptLastAssociationUnresolved'. The field 'keeptLastAssociationUnresolved' has the following description: Keep the last hop while resolving associations to the resolveAssociationDepth unresolved. This is useful while drawing trees of an ontology and we need a quick way to tell if the tree can be expanded further

Returns:
the value of field 'KeeptLastAssociationUnresolved'.

getMaximumToReturn

public java.lang.Integer getMaximumToReturn()
Returns the value of field 'maximumToReturn'. The field 'maximumToReturn' has the following description: Maximum number of entries to return; a value less than 1 Maximum number of entries to return; a value less than 1 indicates to return unlimited entries (to the limit specified in the runtime configuration file).

Returns:
the value of field 'MaximumToReturn'.

getPropertyNames

public LocalNameList getPropertyNames()
Returns the value of field 'propertyNames'.

Returns:
the value of field 'PropertyNames'.

getPropertyTypes

public PropertyType getPropertyTypes(int index)
                              throws java.lang.IndexOutOfBoundsException
Method getPropertyTypes.

Parameters:
index -
Returns:
the value of the org.LexGrid.LexBIG.DataModel.enums.PropertyType at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getPropertyTypes

public PropertyType[] getPropertyTypes()
Method getPropertyTypes.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:
this collection as an Array

getPropertyTypesCount

public int getPropertyTypesCount()
Method getPropertyTypesCount.

Returns:
the size of this collection

getResolveAssociationDepth

public java.lang.Integer getResolveAssociationDepth()
Returns the value of field 'resolveAssociationDepth'. The field 'resolveAssociationDepth' has the following description: Number of hops to resolve associations. 0 means leave all associations unresolved, 1 means immediate neighbors, etc. -1 means follow the entire closure of the graph.

Returns:
the value of field 'ResolveAssociationDepth'.

getResolveBackwards

public java.lang.Boolean getResolveBackwards()
Returns the value of field 'resolveBackwards'. The field 'resolveBackwards' has the following description: True means resolve the target to source associations

Returns:
the value of field 'ResolveBackwards'.

getResolveCodedEntryDepth

public java.lang.Integer getResolveCodedEntryDepth()
Returns the value of field 'resolveCodedEntryDepth'. The field 'resolveCodedEntryDepth' has the following description: Depth in the graph to resolve coded entries. - 1 means don't resolve anything - just return the concept references, 0 means resolve just the root nodes, 1 means resolve 1 deep, etc.

Returns:
the value of field 'ResolveCodedEntryDepth'.

getResolveForward

public java.lang.Boolean getResolveForward()
Returns the value of field 'resolveForward'. The field 'resolveForward' has the following description: True means resolve from the source to the target direction.

Returns:
the value of field 'ResolveForward'.

getSortOptions

public SortOptionList getSortOptions()
Returns the value of field 'sortOptions'.

Returns:
the value of field 'SortOptions'.

isKeeptLastAssociationUnresolved

public java.lang.Boolean isKeeptLastAssociationUnresolved()
Returns the value of field 'keeptLastAssociationUnresolved'. The field 'keeptLastAssociationUnresolved' has the following description: Keep the last hop while resolving associations to the resolveAssociationDepth unresolved. This is useful while drawing trees of an ontology and we need a quick way to tell if the tree can be expanded further

Returns:
the value of field 'KeeptLastAssociationUnresolved'.

isResolveBackwards

public java.lang.Boolean isResolveBackwards()
Returns the value of field 'resolveBackwards'. The field 'resolveBackwards' has the following description: True means resolve the target to source associations

Returns:
the value of field 'ResolveBackwards'.

isResolveForward

public java.lang.Boolean isResolveForward()
Returns the value of field 'resolveForward'. The field 'resolveForward' has the following description: True means resolve from the source to the target direction.

Returns:
the value of field 'ResolveForward'.

iteratePropertyTypes

public java.util.Iterator<PropertyType> iteratePropertyTypes()
Method iteratePropertyTypes.

Returns:
an Iterator over all possible elements in this collection

removeAllPropertyTypes

public void removeAllPropertyTypes()

removePropertyTypes

public boolean removePropertyTypes(PropertyType vPropertyTypes)
Method removePropertyTypes.

Parameters:
vPropertyTypes -
Returns:
true if the object was removed from the collection.

removePropertyTypesAt

public PropertyType removePropertyTypesAt(int index)
Method removePropertyTypesAt.

Parameters:
index -
Returns:
the element removed from the collection

setFilterOptions

public void setFilterOptions(LocalNameList filterOptions)
Sets the value of field 'filterOptions'.

Parameters:
filterOptions - the value of field 'filterOptions'.

setGraphFocus

public void setGraphFocus(ConceptReference graphFocus)
Sets the value of field 'graphFocus'.

Parameters:
graphFocus - the value of field 'graphFocus'.

setKeeptLastAssociationUnresolved

public void setKeeptLastAssociationUnresolved(java.lang.Boolean keeptLastAssociationUnresolved)
Sets the value of field 'keeptLastAssociationUnresolved'. The field 'keeptLastAssociationUnresolved' has the following description: Keep the last hop while resolving associations to the resolveAssociationDepth unresolved. This is useful while drawing trees of an ontology and we need a quick way to tell if the tree can be expanded further

Parameters:
keeptLastAssociationUnresolved - the value of field 'keeptLastAssociationUnresolved'.

setMaximumToReturn

public void setMaximumToReturn(java.lang.Integer maximumToReturn)
Sets the value of field 'maximumToReturn'. The field 'maximumToReturn' has the following description: Maximum number of entries to return; a value less than 1 Maximum number of entries to return; a value less than 1 indicates to return unlimited entries (to the limit specified in the runtime configuration file).

Parameters:
maximumToReturn - the value of field 'maximumToReturn'.

setPropertyNames

public void setPropertyNames(LocalNameList propertyNames)
Sets the value of field 'propertyNames'.

Parameters:
propertyNames - the value of field 'propertyNames'.

setPropertyTypes

public void setPropertyTypes(int index,
                             PropertyType vPropertyTypes)
                      throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vPropertyTypes -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setPropertyTypes

public void setPropertyTypes(PropertyType[] vPropertyTypesArray)
Parameters:
vPropertyTypesArray -

setResolveAssociationDepth

public void setResolveAssociationDepth(java.lang.Integer resolveAssociationDepth)
Sets the value of field 'resolveAssociationDepth'. The field 'resolveAssociationDepth' has the following description: Number of hops to resolve associations. 0 means leave all associations unresolved, 1 means immediate neighbors, etc. -1 means follow the entire closure of the graph.

Parameters:
resolveAssociationDepth - the value of field 'resolveAssociationDepth'.

setResolveBackwards

public void setResolveBackwards(java.lang.Boolean resolveBackwards)
Sets the value of field 'resolveBackwards'. The field 'resolveBackwards' has the following description: True means resolve the target to source associations

Parameters:
resolveBackwards - the value of field 'resolveBackwards'

setResolveCodedEntryDepth

public void setResolveCodedEntryDepth(java.lang.Integer resolveCodedEntryDepth)
Sets the value of field 'resolveCodedEntryDepth'. The field 'resolveCodedEntryDepth' has the following description: Depth in the graph to resolve coded entries. - 1 means don't resolve anything - just return the concept references, 0 means resolve just the root nodes, 1 means resolve 1 deep, etc.

Parameters:
resolveCodedEntryDepth - the value of field 'resolveCodedEntryDepth'.

setResolveForward

public void setResolveForward(java.lang.Boolean resolveForward)
Sets the value of field 'resolveForward'. The field 'resolveForward' has the following description: True means resolve from the source to the target direction.

Parameters:
resolveForward - the value of field 'resolveForward'.

setSortOptions

public void setSortOptions(SortOptionList sortOptions)
Sets the value of field 'sortOptions'.

Parameters:
sortOptions - the value of field 'sortOptions'.

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.