uk.ac.ed.epcc.webapp.model

Class TextFileOverlay.TextFile

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObject

uk.ac.ed.epcc.webapp.model.TextFileOverlay.TextFile

All Implemented Interfaces:

Contexed, ContextIndexed, Identified, Indexed, Releasable, Retirable, TextProvider

Direct Known Subclasses:

XMLOverlay.XMLFile

Enclosing class:

TextFileOverlay<T extends TextFileOverlay.TextFile>

public static class TextFileOverlay.TextFile
extends DataObject
implements Retirable, TextProvider

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.DataObject

DEBUG, record

Fields inherited from interface uk.ac.ed.epcc.webapp.forms.Identified

MAX_IDENTIFIER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextFile(Repository.Record r, java.net.URL base)

Method Summary

Modifier and Type	Method and Description
boolean	canRetire() Is this object in a state that allows it to be retired.
java.lang.String	getData() get a string representation of the current data balue
java.lang.String	getGroup()
java.lang.String	getIdentifier(int max) Generate Identifier with advisory max length.
java.lang.String	getName()
java.io.InputStream	getResourceStream() Get the underlying resource as a stream
java.lang.String	getResourceString() Get he underlying resoruce as a String
java.lang.String	getText() Get the override text.
boolean	hasData() Is there data for this resource
void	retire() retire this object.
void	setGroup(java.lang.String group)
void	setName(java.lang.String name)
void	setText(java.lang.String text)

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.DataObject

addToMap, addToMap, addToMap, commit, delete, empty, equals, formUpdate, getContext, getDatabaseService, getFactoryTag, getID, getIdentifier, getLogger, getMap, getMap, getOwningFactory, getRecord, getRecord, getRecord, getSQLContext, getUniqueIdName, hashCode, isLocked, lock, post_commit, postCreate, pre_commit, release, setContents, setDirty, setMap, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.webapp.model.TextProvider

getDataReader

Constructor Detail

TextFile

protected TextFile(Repository.Record r,
                   java.net.URL base)

Method Detail

hasData

public boolean hasData()

Is there data for this resource

Specified by:

hasData in interface TextProvider

Returns:

boolean true if data exists

getResourceStream

public java.io.InputStream getResourceStream()

Get the underlying resource as a stream

Returns:

InputStream

getName

public java.lang.String getName()

getGroup

public java.lang.String getGroup()

getText

public java.lang.String getText()

Get the override text.

Returns:

String text

setText

public void setText(java.lang.String text)

setGroup

public void setGroup(java.lang.String group)

setName

public void setName(java.lang.String name)

getResourceString

public java.lang.String getResourceString()

Get he underlying resoruce as a String

Returns:

String text

getData

public java.lang.String getData()

get a string representation of the current data balue

Specified by:

getData in interface TextProvider

Returns:

getIdentifier

public java.lang.String getIdentifier(int max)

Description copied from interface: Identified

Generate Identifier with advisory max length.

Specified by:

getIdentifier in interface Identified

Overrides:

getIdentifier in class DataObject

Parameters:

max - advisory max length

Returns:

String identifier

canRetire

public boolean canRetire()

Description copied from interface: Retirable

Is this object in a state that allows it to be retired.

Specified by:

canRetire in interface Retirable

Returns:

boolean true if retire is possible

retire

public void retire()
            throws java.lang.Exception

Description copied from interface: Retirable

retire this object.

Specified by:

retire in interface Retirable

Throws:

java.lang.Exception