org.dspace.app.xmlui.cocoon
Interface DSpaceTransformer

All Superinterfaces:

WingTransformer

All Known Implementing Classes:

AbstractDSpaceTransformer, AbstractSearch, AbstractStep, AbstractSubmissionStep, AddBitstreamForm, AddEPersonForm, AdvacedAuthorizationsForm, AdvancedFormTest, AdvancedSearch, AssignCollectionRoles, AssignCommunityRoles, AuthorizationMain, BasicFormTest, BrowseItemForm, CannotRegister, CCLicenseStep, ChoiceLookupTransformer, CollectionRecentSubmissions, CollectionSearch, CollectionViewer, CollectionViewer, CommunityBrowser, CommunityRecentSubmissions, CommunitySearch, CommunityViewer, CompletedStep, ConfigurableBrowse, ConfirmItemForm, Contact, ControlPanel, CreateCollectionForm, CreateCommunityForm, CurateCollectionForm, CurateCommunityForm, CurateItemForm, DeleteBitstreamFormatsConfirm, DeleteBitstreamsConfirm, DeleteCollectionConfirm, DeleteCollectionRoleConfirm, DeleteCommunityConfirm, DeleteCommunityRoleConfirm, DeleteEPeopleConfirm, DeleteGroupsConfirm, DeleteMetadataFieldsConfirm, DeleteMetadataSchemaConfirm, DeletePoliciesConfirm, DescribeStep, EditBitstreamForm, EditBitstreamFormat, EditCollectionHarvestingForm, EditCollectionMetadataForm, EditCommunityMetadataForm, EditContainerPolicies, EditEPersonForm, EditFileStep, EditGroupForm, EditItemBitstreamsForm, EditItemMetadataForm, EditItemPolicies, EditItemStatusForm, EditMetadataSchema, EditPolicyForm, EditProfile, FailedAuthentication, FeedbackForm, FeedbackSent, FindItemForm, ForgotPasswordFinished, FormatRegistryMain, FrontPageSearch, HTMLTest, InitialQuestionsStep, InlineFormTest, InvalidToken, ItemExport, ItemViewer, LDAPLogin, LicenseStep, LoginChooser, ManageEPeopleMain, ManageGroupsMain, MapperMain, MetadataImportConfirm, MetadataImportMain, MetadataImportUpload, MetadataRegistryMain, MoveItemForm, MoveMetadataFields, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, NotAuthorized, NoticeTransformer, PageNotFoundTransformer, PasswordLogin, PerformTaskStep, ProfileUpdated, RegistrationFinished, RejectTaskStep, RemovedStep, ResetPassword, RestrictedItem, ResumeStep, ReviewStep, SaveOrRemoveStep, SearchItemForm, SelectCollectionStep, SetupCollectionHarvestingForm, SimpleSearch, StartForgotPassword, StartRegistration, StatisticsTransformer, StatisticsViewer, StepTransformer, StructureTest, Submissions, SystemwideAlerts, ToggleCollectionHarvestingForm, UploadStep, VerifyEmail, ViewItem, WithdrawnItems

public interface DSpaceTransformer
extends WingTransformer

The WingTransformer is a simple framework for dealing with DSpace based SAX events. The implementing class is responsable for catching the approprate events and filtering them into these method calls. This allows implementors to have easy access to the document without dealing with the messyness of the sax event system.

Author:

Scott Phillips

Method Summary

void	addBody(Body body) What to add at the end of the body
void	addOptions(Options options) What to add to the options list
void	addPageMeta(PageMeta pageMeta) What page metadata to add to the document
void	addUserMeta(UserMeta userMeta) What user metadata to add to the document
java.lang.String	getComponentName() What is a unique name for this component?

Method Detail

addBody

void addBody(Body body)
             throws org.xml.sax.SAXException,
                    WingException,
                    UIException,
                    java.sql.SQLException,
                    java.io.IOException,
                    AuthorizeException

What to add at the end of the body

Specified by:

addBody in interface WingTransformer

Throws:

org.xml.sax.SAXException

WingException

UIException

java.sql.SQLException

java.io.IOException

AuthorizeException

addOptions

void addOptions(Options options)
                throws org.xml.sax.SAXException,
                       WingException,
                       UIException,
                       java.sql.SQLException,
                       java.io.IOException,
                       AuthorizeException

What to add to the options list

Specified by:

addOptions in interface WingTransformer

Throws:

org.xml.sax.SAXException

WingException

UIException

java.sql.SQLException

java.io.IOException

AuthorizeException

addUserMeta

void addUserMeta(UserMeta userMeta)
                 throws org.xml.sax.SAXException,
                        WingException,
                        UIException,
                        java.sql.SQLException,
                        java.io.IOException,
                        AuthorizeException

What user metadata to add to the document

Specified by:

addUserMeta in interface WingTransformer

Throws:

org.xml.sax.SAXException

WingException

UIException

java.sql.SQLException

java.io.IOException

AuthorizeException

addPageMeta

void addPageMeta(PageMeta pageMeta)
                 throws org.xml.sax.SAXException,
                        WingException,
                        UIException,
                        java.sql.SQLException,
                        java.io.IOException,
                        AuthorizeException

What page metadata to add to the document

Specified by:

addPageMeta in interface WingTransformer

Throws:

org.xml.sax.SAXException

WingException

UIException

java.sql.SQLException

java.io.IOException

AuthorizeException

getComponentName

java.lang.String getComponentName()

What is a unique name for this component?

Specified by:

getComponentName in interface WingTransformer