All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface edu.vt.marian.common.DigInfObj

public interface DigInfObj
extends Cloneable
A Digital Information Object is a digital object whose primary function is to carry information (generally although not necessarily to a human being. DIOs occupy the place of Streams in the 5S model, and of text documents in a classical information retrieval system.

DigInfObjs do not need to be made up of text. We require them, however, to be able to produce a short piece of text that will serve as a surrogate or short description, for instance in a list of search results or as the label on an image. Since that text also has a context, it can be produced in a variety of markups, selected by a flag in the presentShort() method.

Variable Index

o ANSEL
o ASCII
these are the possible markup types
o HTML
o SGML
o XML

Method Index

o copy()
o isValid()
o presentShort(int)
o presentShort(int, BufferedWriter)

Variables

o ASCII 
 public static final int ASCII
these are the possible markup types

o ANSEL 
 public static final int ANSEL
o HTML 
 public static final int HTML
o SGML 
 public static final int SGML
o XML 
 public static final int XML

Methods

o isValid 
 public abstract boolean isValid()
o presentShort 
 public abstract String presentShort(int markupType)
o presentShort 
 public abstract int presentShort(int markupType,
                                  BufferedWriter out) throws IOException
o copy 
 public abstract DigInfObj copy()

All Packages  Class Hierarchy  This Package  Previous  Next  Index