org.dspace.app.xmlui.cocoon

Interface DSpaceTransformer

All Superinterfaces:

WingTransformer

All Known Implementing Classes:

AbstractControlPanelTab, AbstractDSpaceTransformer, AbstractRecentSubmissionTransformer, AbstractSearch, AbstractStatisticsDataTransformer, AbstractStep, AbstractSubmissionStep, AbstractXMLUIAction, AcceptEditRejectAction, AccessStep, AccessStepUtil, AddBitstreamForm, AddEPersonForm, AdvacedAuthorizationsForm, AdvancedFormTest, AssignCollectionRoles, AssignCommunityRoles, AuthorizationMain, BasicFormTest, BatchImportConfirm, BatchImportMain, BatchImportUpload, BrowseFacet, BrowseItemForm, CannotRegister, CCLicenseStep, ChoiceLookupTransformer, ClaimAction, CollectionBrowse, CollectionRecentSubmissions, CollectionSearch, CollectionViewer, CollectionViewer, CommunityBrowse, CommunityBrowser, CommunityRecentSubmissions, CommunitySearch, CommunityViewer, CompletedStep, ConfigurableBrowse, ConfirmItemForm, Contact, ControlledVocabularyTransformer, ControlPanel, ControlPanelAlertsTab, ControlPanelConfigurationTab, ControlPanelCurrentActivityTab, ControlPanelHarvestingTab, ControlPanelJavaTab, CreateCollectionForm, CreateCommunityForm, CSVExportDiscoveryNavigation, CurateCollectionForm, CurateCommunityForm, CurateForm, CurateItemForm, DeleteBitstreamFormatsConfirm, DeleteBitstreamsConfirm, DeleteCollectionConfirm, DeleteCollectionRoleConfirm, DeleteCommunityConfirm, DeleteCommunityRoleConfirm, DeleteEPeopleConfirm, DeleteGroupsConfirm, DeleteMetadataFieldsConfirm, DeleteMetadataSchemaConfirm, DeletePoliciesConfirm, DeleteVersionsConfirm, DescribeStep, EditBitstreamForm, EditBitstreamFormat, EditBitstreamPolicies, EditCollectionHarvestingForm, EditCollectionMetadataForm, EditCommunityMetadataForm, EditContainerPolicies, EditEPersonForm, EditFileStep, EditGroupForm, EditItemBitstreamsForm, EditItemMetadataForm, EditItemPolicies, EditItemStatusForm, EditMetadataSchema, EditPolicyForm, EditPolicyStep, EditProfile, ElasticSearchStatsViewer, FailedAuthentication, FeedbackForm, FeedbackSent, FinalEditAction, FindItemForm, ForgotPasswordFinished, FormatRegistryMain, FrontPageFeeds, HTMLTest, InitialQuestionsStep, InlineFormTest, InvalidToken, ItemExport, ItemRequestChangeStatusForm, ItemRequestContactAuthor, ItemRequestContactRequester, ItemRequestForm, ItemRequestResponseDecisionForm, ItemRequestResponseFalseForm, ItemRequestResponseSent, ItemRequestResponseTrueForm, ItemRequestSent, ItemRequestStatusChanged, ItemViewer, LDAPLogin, LicenseStep, LoginChooser, ManageEPeopleMain, ManageGroupsMain, MapperMain, MetadataImportConfirm, MetadataImportMain, MetadataImportUpload, MetadataRegistryMain, MoveItemForm, MoveMetadataFields, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, NotAuthorized, NoticeTransformer, PageNotFoundTransformer, PasswordLogin, PerformTaskStep, PrivateItems, ProfileUpdated, RecentSubmissionTransformer, RegistrationFinished, RejectTaskStep, RelatedItems, RemovedStep, ResetPassword, RestoreVersionForm, RestrictedItem, ResumeStep, ReviewAction, ReviewStep, RobotsNoIndexTransformer, SaveOrRemoveStep, ScoreReviewAction, SearchFacetFilter, SearchItemForm, SelectCollectionStep, SelectCollectionTransformer, SelectPackagingTransformer, SelectReviewerAction, SelectTargetTransformer, SetupCollectionHarvestingForm, SidebarFacetsTransformer, SimpleSearch, SingleUserReviewAction, SiteRecentSubmissions, SiteViewer, StartForgotPassword, StartRegistration, StartSubmissionLookupStep, StaticPage, StatisticsGoogleAnalyticsTransformer, StatisticsSearchTransformer, StatisticsTransformer, StatisticsViewer, StatisticsWorkflowTransformer, StepTransformer, StructureTest, Submissions, Submissions, Submissions, SwordResponseTransformer, SystemwideAlerts, ToggleCollectionHarvestingForm, UploadStep, UploadWithEmbargoStep, VerifyEmail, VersionHistoryForm, VersionItemForm, VersionNoticeTransformer, VersionUpdateForm, ViewItem, WithdrawnItems, WorkflowExceptionTransformer, WorkflowItemTransformer, WorkflowOverviewTransformer, WorkflowTransformer

public interface DSpaceTransformer
extends WingTransformer

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

Author:

Scott Phillips

Method Summary

Methods

Modifier and Type	Method and Description
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
String	getComponentName() What is a unique name for this component?

Method Detail

addBody

void addBody(Body body)
             throws SAXException,
                    WingException,
                    UIException,
                    SQLException,
                    IOException,
                    AuthorizeException,
                    org.apache.cocoon.ProcessingException

What to add at the end of the body

Specified by:

addBody in interface WingTransformer

Parameters:

body - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

org.apache.cocoon.ProcessingException - whenever.

addOptions

void addOptions(Options options)
                throws SAXException,
                       WingException,
                       UIException,
                       SQLException,
                       IOException,
                       AuthorizeException

What to add to the options list

Specified by:

addOptions in interface WingTransformer

Parameters:

options - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

addUserMeta

void addUserMeta(UserMeta userMeta)
                 throws SAXException,
                        WingException,
                        UIException,
                        SQLException,
                        IOException,
                        AuthorizeException

What user metadata to add to the document

Specified by:

addUserMeta in interface WingTransformer

Parameters:

userMeta - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

addPageMeta

void addPageMeta(PageMeta pageMeta)
                 throws SAXException,
                        WingException,
                        UIException,
                        SQLException,
                        IOException,
                        AuthorizeException

What page metadata to add to the document

Specified by:

addPageMeta in interface WingTransformer

Parameters:

pageMeta - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

getComponentName

String getComponentName()

What is a unique name for this component?

Specified by:

getComponentName in interface WingTransformer

Returns:

the name.