org.LexGrid.LexBIG.Impl.helpers.lazyloading
Class AbstractLazyLoadableCodeToReturn

java.lang.Object
  extended by org.LexGrid.LexBIG.Impl.helpers.CodeToReturn
      extended by org.LexGrid.LexBIG.Impl.helpers.lazyloading.AbstractLazyLoadableCodeToReturn
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AbstractNonProxyLazyCodeToReturn

public abstract class AbstractLazyLoadableCodeToReturn
extends CodeToReturn

The Class LazyLoadableCodeToReturn.

Author:
Kevin Peterson
See Also:
Serialized Form

Constructor Summary
AbstractLazyLoadableCodeToReturn()
          Instantiates a new lazy loadable code to return.
AbstractLazyLoadableCodeToReturn(float score, int documentId)
          Instantiates a new lazy loadable code to return.
AbstractLazyLoadableCodeToReturn(org.apache.lucene.search.ScoreDoc scoreDoc)
          Instantiates a new lazy loadable code to return.
 
Method Summary
protected abstract  org.apache.lucene.document.Document buildDocument()
           
 void compact()
           
protected abstract  void doCompact()
           
 int getDocumentId()
          Gets the document id.
protected  EntityIndexService getEntityIndexService()
           
protected  SystemResourceService getSystemResourceService()
           
 void hydrate()
          Hydrate.
 boolean isHydrated()
          Checks if is hydrated.
 void setDocumentId(int documentId)
          Sets the document id.
 
Methods inherited from class org.LexGrid.LexBIG.Impl.helpers.CodeToReturn
equals, getCode, getEntityDescription, getEntityTypes, getEntityUid, getNamespace, getScore, getUri, getVersion, hashCode, setCode, setEntityDescription, setEntityTypes, setEntityUid, setNamespace, setScore, setUri, setVersion, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractLazyLoadableCodeToReturn

public AbstractLazyLoadableCodeToReturn()
Instantiates a new lazy loadable code to return.


AbstractLazyLoadableCodeToReturn

public AbstractLazyLoadableCodeToReturn(org.apache.lucene.search.ScoreDoc scoreDoc)
Instantiates a new lazy loadable code to return.

Parameters:
scoreDoc - the score doc
internalCodeSystemName - the internal code system name
internalVersionString - the internal version string

AbstractLazyLoadableCodeToReturn

public AbstractLazyLoadableCodeToReturn(float score,
                                        int documentId)
Instantiates a new lazy loadable code to return.

Parameters:
internalCodeSystemName - the internal code system name
internalVersionString - the internal version string
score - the score
documentId - the document id
Method Detail

compact

public void compact()
Overrides:
compact in class CodeToReturn

doCompact

protected abstract void doCompact()

hydrate

public void hydrate()
             throws java.lang.Exception
Hydrate.

Throws:
java.lang.Exception - the exception

buildDocument

protected abstract org.apache.lucene.document.Document buildDocument()
                                                              throws java.lang.Exception
Throws:
java.lang.Exception

getEntityIndexService

protected EntityIndexService getEntityIndexService()

getSystemResourceService

protected SystemResourceService getSystemResourceService()

isHydrated

public boolean isHydrated()
Checks if is hydrated.

Returns:
true, if is hydrated

getDocumentId

public int getDocumentId()
Gets the document id.

Returns:
the document id

setDocumentId

public void setDocumentId(int documentId)
Sets the document id.

Parameters:
documentId - the new document id

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.