interface: XmlTransforming

public abstract <<interface>> interface: XmlTransforming
Author: Johannes Mueller @revised by MuJ: 05.09.2007
Project: Phase: 1.0; Status: Proposed; Version: $Revision: 2125 $ $LastChangedDate: 2009-06-23 09:; Complexity: 1
Dates: Created: 16.07.2009 15:14:37; Modified: 16.07.2009 15:14:37;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {F7FD0999-4989-4970-AE45-9040B9155E3A}
The interface with the XML transforming methods.
 

Goto: Fields, Methods

See also: DataGatheringBean, XmlTransformingBean, EncodingTest, Bug213SetContentTypeToNullTest, Bug282InconsistentBehaviourOfMethodRetrievePathListTest, ItemUpdateAndBaseURLTest, TransformAccountUserAndGrantsIntegrationTest, TransformAffiliationIntegrationTest, TransformContainerIntegrationTest, TransformPubCollectionIntegrationTest, TransformPubItemIntegrationTest, TransformPubItemResultListIntegrationTest, TransformPubItemVersionListIntegrationTest, TransformSchindlMayrIntegrationTest, AffiliationCreator, SearchBean, ItemValidatingBean, ValidationSchemaCache, ValidatorTest

Appears in: common

Connections
 
XmlTransforming Attributes
Attribute Details
public static const String
  SERVICE_NAME
Initial: "ejb/de/mpg/escidoc/services/pubman/XmlTransforming"
Notes: The name of the EJB service.
 
XmlTransforming Methods
Operation Details
public
transformToAccountUser(
   String user):AccountUserVO
Sequential
Tags: throws=TechnicalException,UnmarshallingException
Notes: Transforms an XML String that is valid according to "${xsd.soap.useraccount.useraccount}" (user-account.xsd) to the corresponding <code>AccountUserVO</code>.
@return The corresponding <code>AccountUserVO</code>
public
transformToAccountUser(
   AccountUserVO accountUserVO):String
Sequential
Tags: throws=TechnicalException
public
transformToAccountUserVOList(
   String accountUserListXml):List
Sequential
Tags: throws=TechnicalException
public
transformToAffiliation(
   String organizationalUnit):AffiliationVO
Sequential
Tags: throws=TechnicalException,UnmarshallingException
Notes: Transforms an XML String that is valid according to "${xsd.soap.ou.ou}" (organizational-unit.xsd) to the corresponding <code>AffiliationVO</code>.
@return The corresponding <code>AffiliationVO</code>
public
transformToAffiliationList(
   String organizationalUnitList):List
Sequential
Tags: throws=TechnicalException,UnmarshallingException
Notes: Transforms an XML String that is valid according to "http://www.escidoc. de/schemas/organizationalunitlist/0.6" (organizational-unit-list.xsd) to the corresponding <code>List<AffiliationVO></code>.
@return The corresponding <code>List<AffiliationVO></code>
public
transformToAffiliationPathList(
   String pathList):List
Sequential
Tags: throws=TechnicalException,UnmarshallingException
Notes: Transforms an XML String that is valid according to "http://www.escidoc. de/schemas/organizationalunitpathlist/0.2" (organizational-unit-path-list.xsd) to the corresponding
<code>List<AffiliationPath></code>.
@return The corresponding <code>List<AffiliationPath></code>
public
transformToAffiliationResult(
   String affiliationResult):AffiliationResultVO
Sequential
Tags: annotations=@Deprecated
throws=TechnicalException
Notes: Transform a xml string to a organizational unit result.
@deprecated Please use XmlTransforming.transformToSearchResult instead.
@return ou search result
public
transformToContainer(
   String containerXml):ContainerVO
Sequential
Tags: throws=TechnicalException
public
transformToContainer(
   ContainerVO containerVO):String
Sequential
Tags: throws=TechnicalException
public
transformToContainerList(
   String containerList):List
Sequential
Tags: throws=TechnicalException
Notes: Transform a xml string to a container list.
@return list of containers
public
transformToContainerList(
   List containerVOList):String
Sequential
Tags: throws=TechnicalException
public
transformToContainerListWrapper(
   String containerListXml):ContainerVOListWrapper
Sequential
Tags: throws=TechnicalException
public
transformToContainerResult(
   String containerResult):ContainerResultVO
Sequential
Tags: annotations=@Deprecated
throws=TechnicalException
Notes: Transform a xml string to a container result.
@deprecated Please use XmlTransforming.transformToSearchResult instead.
@return container search result
public
transformToContext(
   String context):ContextVO
Sequential
Tags: throws=TechnicalException
Notes: Transforms an XML String that is valid according to "${xsd.soap.context.context}" (context.xsd) to the corresponding <code>ContextVO</code>.
@return The corresponding <code>ContextVO</code>
public
transformToContextList(
   String contextList):List
Sequential
Tags: throws=TechnicalException
Notes: Transforms an XML String that is valid according to "http://www.escidoc.de/schemas/contextlist/0.2" (context-list.xsd) to the corresponding <code>List<ContextVO></code>.
@return The corresponding <code>List<ContextVO></code>
public
transformToEventVOList(
   String versionList):List
Sequential
Tags: throws=TechnicalException
Notes: Transforms an XML String that is valid according to "http://www.escidoc. de/schemas/..." (version-history.xsd) to the corresponding
<code>List<VersionHistoryEntryVO></code>.
@return The corresponding <code>List<VersionHistoryEntryVO></code>
public
transformToExportFormatVOList(
   String xml):List
Sequential
Tags: throws=TechnicalException,UnmarshallingException
Notes: This method gets as input a XML (as String) containing the existing citation styles and their file formats. It returns a list of <code>LayoutFormatVOs</code> according to the input.
@return List of <code>LayoutFormatVOs</code> according to the input
public
transformToExportParams(
   ExportFormatVO exportFormat):String
Sequential
Tags: throws=TechnicalException,MarshallingException
Notes: Transforms a given <code>ExportFormatVO</code> to corresponding XML.
@return The corresponding XML
public
transformToFaceItem(
   String itemXml):FaceItemVO
Sequential
Tags: throws=TechnicalException
public
transformToFaceItemList(
   String itemList):List
Sequential
Tags: throws=TechnicalException
public
transformToFileVO(
   String fileXML):FileVO
Sequential
Tags: throws=TechnicalException
public
transformToFilterTaskParam(
   FilterTaskParamVO filter):String
Sequential
Tags: throws=TechnicalException,MarshallingException
Notes: Transforms a given <code>FilterTaskParamVO</code> to corresponding XML that is valid according to (filter.xsd, filter-containers.xsd, filter-contexts.xsd, filter-items.xsd, or filter-organizational-units.xsd respectively).
@return Corresponding XML that is valid according to (filter.xsd, filter-containers.xsd, filter-contexts.xsd, filter-items.xsd, or filter-organizational-units.xsd respectively)
public
transformToGrant(
   GrantVO grantVO):String
Sequential
Tags: throws=TechnicalException
Notes: Transforms an <code>GrantVO</code> to the corresponding xml that is valid according to "http://www.escidoc.de/schemas/grants/0.2" (grants.xsd)
@return XML String that is valid according to "http://www.escidoc.de/schemas/grants/0.2" (grants.xsd)
public
transformToGrantVO(
   String xmlGrant):GrantVO
Sequential
Tags: throws=TechnicalException
Notes: Transforms an XML String that is valid according to "http://www.escidoc.de/schemas/grants/0.2" (grants.xsd) to the corresponding <code>GrantVO</code>.
@param xmlGrants XML String that is valid according to "http://www.escidoc.de/schemas/grants/0.2" (grants.xsd)
@return The corresponding <code>GrantVO</code>
public
transformToGrantVOList(
   String xmlGrants):java.util.List
Sequential
Tags: throws=TechnicalException
Notes: Transforms an XML String that is valid according to "http://www.escidoc.de/schemas/grants/0.2" (grants.xsd) to the corresponding <code>GrantVO</code>.
@return The corresponding <code>GrantVO</code>
public
transformToItem(
   ItemVO pubItem):String
Sequential
Tags: throws=TechnicalException
Notes: Transforms a given <code>PubItemVO</code> to corresponding XML that is valid according to "http://www.escidoc. de/schemas/item/0.3" (item.xsd).
@return Corresponding XML that is valid according to "http://www.escidoc.de/schemas/item/0.3" (item.xsd)
public
transformToItem(
   String item):ItemVO
Sequential
Tags: throws=TechnicalException
Notes: Transforms an XML String that is valid according to "http://www.escidoc.de/schemas/item/0.2" (item. xsd) to the corresponding <code>ItemVO</code>.
@return The corresponding <code>ItemVO</code>
public
transformToItemList(
   List itemVOList):String
Sequential
Tags: throws=TechnicalException
Notes: Transforms a given <code>List<ItemVO></code> to corresponding XML that is valid according to "http://www. escidoc.de/schemas/itemlist/0.2" (item-list.xsd).
@return Corresponding XML that is valid according to "http://www.escidoc.de/schemas/itemlist/0.2" (item-list.xsd)
public
transformToItemList(
   String itemList):List
Sequential
Tags: throws=TechnicalException
Notes: Transforms an XML String that is valid according to "http://www.escidoc.de/schemas/itemlist/0.2" (item-list.xsd) to the corresponding <code>List<ItemVO></code>.
@return The corresponding <code>List<ItemVO></code>
public
transformToItemListWrapper(
   String itemListXml):ItemVOListWrapper
Sequential
Tags: throws=TechnicalException
public
transformToItemResultVO(
   String searchResultItem):ItemResultVO
Sequential
Tags: annotations=@Deprecated
throws=TechnicalException
Notes: Transforms an XML String that is valid according to "${xsd.soap.searchresult.searchresult}" (search-result.xsd) to the corresponding <code>ItemResultVO</code>.
@deprecated Please use XmlTransforming.transformToSearchResult instead.
@return The corresponding <code>ItemResultVO</code>
public
transformToLockVO(
   String lockInformation):LockVO
Sequential
Tags: throws=TechnicalException,UnmarshallingException
Notes: Not implemented yet.
@return Nothing valuable.
public
transformToMemberList(
   String memberListXml):List
Sequential
Tags: throws=TechnicalException
public
transformToMemberList(
   List memberList):String
Sequential
Tags: throws=TechnicalException
public
transformToOrganizationalUnit(
   AffiliationVO affiliation):String
Sequential
Tags: throws=TechnicalException,MarshallingException
Notes: Transforms a given <code>AffiliationVO</code> to corresponding XML that is valid according to "${xsd.soap.ou.ou}" (organizational-unit.xsd).
@return Corresponding XML that is valid according to "${xsd.soap.ou.ou}" (organizational-unit.xsd)
public
transformToParentAffiliationList(
   String parentOrganizationalUnitList):List
Sequential
Tags: throws=TechnicalException,UnmarshallingException
Notes: Transforms an XML String that is valid according to "http://www.escidoc. de/schemas/organizationalunitlist/0.6" (organizational-unit.xsd) to the corresponding <code>List<AffiliationRO></code>.
@return The corresponding <code>List<AffiliationRO></code>
public
transformToPidTaskParam(
   PidTaskParamVO pidTaskParam):String
Sequential
Tags: throws=TechnicalException,MarshallingException
Notes: Transforms a given <code>PidTaskParamVO</code> to corresponding XML that is valid according to (filter.xsd, filter- containers.xsd, filter-contexts.xsd, filter-items.xsd, or filter-organizational-units.xsd respectively).
@return Corresponding XML that is valid according to (filter.xsd, filter-containers.xsd, filter-contexts.xsd, filter-items.xsd, or filter-organizational-units.xsd respectively)
public
transformToPubItem(
   String itemXml):PubItemVO
Sequential
Tags: throws=TechnicalException
public
transformToPubItemList(
   String itemList):List
Sequential
Tags: throws=TechnicalException
public
transformToRelationVOList(
   String relationList):List
Sequential
Tags: throws=UnmarshallingException
Notes: Transforms an XML String to the corresponding <code>List<RelationVO></code>.
@return The corresponding <code>List<RelationVO></code>
@return The corresponding <code>List<RelationVO></code>
public
transformToResult(
   String resultXml):ResultVO
Sequential
Tags: throws=TechnicalException
public
transformToSearchResult(
   String searchResultXml):SearchResultElement
Sequential
Tags: throws=TechnicalException
Notes: Transforms an XML String that is valid according to "${xsd.soap.searchresult.searchresult}" (search-result.xsd) to the corresponding <code>ItemResultVO</code>.
@param searchResultItem XML String that is valid according to "${xsd.soap.searchresult.searchresult}" (search-result.xsd)
@return The corresponding <code>ItemResultVO</code>
public
transformToStatisticReportDefinition(
   StatisticReportDefinitionVO reportDef):String
Sequential
Tags: throws=TechnicalException
public
transformToStatisticReportDefinition(
   String reportDefXML):StatisticReportDefinitionVO
Sequential
Tags: throws=TechnicalException
public
transformToStatisticReportDefinitionList(
   String reportDefinitionList):List
Sequential
Tags: throws=TechnicalException
public
transformToStatisticReportParameters(
   StatisticReportParamsVO statisticReportParams):String
Sequential
Tags: throws=TechnicalException
public
transformToStatisticReportRecordList(
   String statisticReportXML):List
Sequential
Tags: throws=TechnicalException
public
transformToSuccessorAffiliationList(
   String successorOrganizationalUnitList):List
Sequential
Tags: throws=TechnicalException,UnmarshallingException
public
transformToTaskParam(
   TaskParamVO taskParam):String
Sequential
Tags: throws=TechnicalException,MarshallingException
Notes: Transforms a given <code>TaskParamVO</code> to corresponding XML that is valid according to (filter.xsd, filter- containers.xsd, filter-contexts.xsd, filter-items.xsd, or filter-organizational-units.xsd respectively).
@return Corresponding XML that is valid according to (filter.xsd, filter-containers.xsd, filter-contexts.xsd, filter-items.xsd, or filter-organizational-units.xsd respectively)
public
transformToTocItem(
   TocItemVO tocItemVO):String
Sequential
Tags: throws=TechnicalException
public
transformToTocItemVO(
   String tocXML):TocItemVO
Sequential
Tags: throws=TechnicalException
public
transformToTocVO(
   String tocXML):TocVO
Sequential
Tags: throws=TechnicalException
public
transformUploadResponseToFileURL(
   String uploadResponse):URL
Sequential
Tags: throws=TechnicalException,UnmarshallingException,URISyntaxException
Notes: Transforms an XML String that is valid according to "http://www.escidoc.de/schemas/stagingfile/0.2" (staging-file.xsd) to the corresponding <code>java.net.URL</code>.
@return The corresponding <code>java.net.URL</code>