Esri Geoportal Server
1.0

com.esri.gpt.control.georss
Class RecordSnippetWriter

java.lang.Object
  extended by com.esri.gpt.control.georss.RecordSnippetWriter

public class RecordSnippetWriter
extends Object

HTML snippet writer.


Nested Class Summary
static class RecordSnippetWriter.Target
          links target
 
Constructor Summary
RecordSnippetWriter(MessageBroker messageBroker, PrintWriter writer)
          Creates instance of the writer.
 
Method Summary
 boolean getClipText()
          Checks if text shoud be clipped.
 boolean getShowDescription()
          Checks if showing description allowed.
 boolean getShowIcon()
          Checks if showing icon allowed.
 boolean getShowLinks()
          Checks if showing links allowed.
 boolean getShowTitle()
          Checks if showing title allowed.
 RecordSnippetWriter.Target getTarget()
          Gets links target.
 void setClipText(boolean clipText)
          Sets clipping text flag.
 void setShowDescription(boolean showDescription)
          Sets showing description flag.
 void setShowIcon(boolean showIcon)
          Sets showing icon flag.
 void setShowLinks(boolean showLinks)
          Sets showing links flag.
 void setShowTitle(boolean showTitle)
          Sets showing title flag.
 void setTarget(RecordSnippetWriter.Target target)
          Sets links target.
 void write(SearchResultRecord record)
          Writes HTML snippet with metadata description.
 void writeLinks(ResourceLinks links)
          Write links.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RecordSnippetWriter

public RecordSnippetWriter(MessageBroker messageBroker,
                           PrintWriter writer)
Creates instance of the writer.

Parameters:
messageBroker - message broker
writer - underlying print writer
Method Detail

getShowTitle

public boolean getShowTitle()
Checks if showing title allowed.

Returns:
true if showing title allowed

setShowTitle

public void setShowTitle(boolean showTitle)
Sets showing title flag.

Parameters:
showTitle - true to show title

getShowIcon

public boolean getShowIcon()
Checks if showing icon allowed.

Returns:
true if showing icon allowed

setShowIcon

public void setShowIcon(boolean showIcon)
Sets showing icon flag.

Parameters:
showIcon - true to show icon

getShowDescription

public boolean getShowDescription()
Checks if showing description allowed.

Returns:
true if showing description allowed

setShowDescription

public void setShowDescription(boolean showDescription)
Sets showing description flag.

Parameters:
showDescription - true to show description

getShowLinks

public boolean getShowLinks()
Checks if showing links allowed.

Returns:
true if showing links allowed

setShowLinks

public void setShowLinks(boolean showLinks)
Sets showing links flag.

Parameters:
showLinks - true to show links

getClipText

public boolean getClipText()
Checks if text shoud be clipped.

Returns:
true if text shoud be clipped

setClipText

public void setClipText(boolean clipText)
Sets clipping text flag.

Parameters:
clipText - true to clip text

getTarget

public RecordSnippetWriter.Target getTarget()
Gets links target.

Returns:
links target

setTarget

public void setTarget(RecordSnippetWriter.Target target)
Sets links target.

Parameters:
target - links target

write

public void write(SearchResultRecord record)
Writes HTML snippet with metadata description.

Parameters:
record - record to write as snippet

writeLinks

public void writeLinks(ResourceLinks links)
Write links.

Parameters:
links - the links

Esri Geoportal Server
1.0

Copyright 2011 Environmental Systems Research Institute. All rights reserved. Use is subject to license terms.