org.LexGrid.LexBIG.Impl.pagedgraph.paging
Class AssociatedConceptIterator

java.lang.Object
  extended by org.lexevs.paging.AbstractPageableIterator<AssociatedConcept>
      extended by org.LexGrid.LexBIG.Impl.pagedgraph.paging.AssociatedConceptIterator
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<AssociatedConcept>, java.util.Iterator<AssociatedConcept>

public class AssociatedConceptIterator
extends AbstractPageableIterator<AssociatedConcept>

The Class AssociatedConceptIterator.

Author:
Kevin Peterson
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.lexevs.paging.AbstractPageableIterator
AbstractPageableIterator.NextDecorator<T>, AbstractPageableIterator.Pager<T>
 
Constructor Summary
AssociatedConceptIterator()
           
AssociatedConceptIterator(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, java.lang.String relationsContainerName, java.lang.String associationPredicateName, java.lang.String entityCode, java.lang.String entityCodeNamespace, boolean resolveForward, boolean resolveBackward, int resolveForwardAssociationDepth, int resolveBackwardAssociationDepth, int resolveCodedEntryDepth, GraphQuery graphQuery, LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes, SortOptionList sortAlgorithms, LocalNameList filterOptions, CycleDetectingCallback cycleDetectingCallback, AssociationListBuilder.AssociationDirection direction, int pageSize)
          Instantiates a new associated concept iterator.
 
Method Summary
protected  AssociatedConcept decorateNext(AssociatedConcept associatedConcept)
          Decorate next.
protected  java.util.List<AssociatedConcept> doPage(int currentPosition, int pageSize)
          Returns a page of results.
protected  java.util.List<AssociatedConcept> filterList(java.util.List<AssociatedConcept> list)
           
protected  CodedNodeGraphDao.TripleNode getAssociatedConceptNode(AssociationListBuilder.AssociationDirection direction)
          Gets the associated concept node.
protected  CodedNodeGraphDao.TripleNode getTripleUidIteratorNode(AssociationListBuilder.AssociationDirection direction)
          Gets the triple uid iterator node.
 
Methods inherited from class org.lexevs.paging.AbstractPageableIterator
doExecutePage, getGlobalPosition, getPageSize, hasNext, isDecorateNext, isPageNeeded, iterator, next, page, pageIfNecessary, remove, setDecorateNext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AssociatedConceptIterator

public AssociatedConceptIterator()

AssociatedConceptIterator

public AssociatedConceptIterator(java.lang.String codingSchemeUri,
                                 java.lang.String codingSchemeVersion,
                                 java.lang.String relationsContainerName,
                                 java.lang.String associationPredicateName,
                                 java.lang.String entityCode,
                                 java.lang.String entityCodeNamespace,
                                 boolean resolveForward,
                                 boolean resolveBackward,
                                 int resolveForwardAssociationDepth,
                                 int resolveBackwardAssociationDepth,
                                 int resolveCodedEntryDepth,
                                 GraphQuery graphQuery,
                                 LocalNameList propertyNames,
                                 CodedNodeSet.PropertyType[] propertyTypes,
                                 SortOptionList sortAlgorithms,
                                 LocalNameList filterOptions,
                                 CycleDetectingCallback cycleDetectingCallback,
                                 AssociationListBuilder.AssociationDirection direction,
                                 int pageSize)
Instantiates a new associated concept iterator.

Parameters:
entityCode - the entity code
entityCodeNamespace - the entity code namespace
direction - the direction
pageSize - the page size
codingSchemeUri - the coding scheme uri
codingSchemeVersion - the coding scheme version
relationsContainerName - the relations container name
associationPredicateName - the association predicate name
resolveForward - the resolve forward
resolveBackward - the resolve backward
resolveForwardAssociationDepth - the resolve forward association depth
resolveBackwardAssociationDepth - the resolve backward association depth
resolveCodedEntryDepth - the resolve coded entry depth
graphQuery - the graph query
filterOptions -
cycleDetectingCallback - the cycle detecting callback
Method Detail

decorateNext

protected AssociatedConcept decorateNext(AssociatedConcept associatedConcept)
Description copied from class: AbstractPageableIterator
Decorate next.

Overrides:
decorateNext in class AbstractPageableIterator<AssociatedConcept>
Parameters:
associatedConcept - the item
Returns:
the t

doPage

protected java.util.List<AssociatedConcept> doPage(int currentPosition,
                                                   int pageSize)
Description copied from class: AbstractPageableIterator
Returns a page of results. NOTE: 'pageSize' is not binding -- it is the suggested page size. Implementing classes may return more or less than the suggested 'pageSize' parameter, although it is generally recommended to abide by the 'pageSize' parameter when possible. A null or empty list returned from this method will signify that the underlying results are exhausted and paging should halt.

Specified by:
doPage in class AbstractPageableIterator<AssociatedConcept>
Parameters:
currentPosition - the current position
pageSize - the page size
Returns:
the list

filterList

protected java.util.List<AssociatedConcept> filterList(java.util.List<AssociatedConcept> list)

getTripleUidIteratorNode

protected CodedNodeGraphDao.TripleNode getTripleUidIteratorNode(AssociationListBuilder.AssociationDirection direction)
Gets the triple uid iterator node.

Parameters:
direction - the direction
Returns:
the triple uid iterator node

getAssociatedConceptNode

protected CodedNodeGraphDao.TripleNode getAssociatedConceptNode(AssociationListBuilder.AssociationDirection direction)
Gets the associated concept node.

Parameters:
direction - the direction
Returns:
the associated concept node

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.