@Transactional @Service public class DefaultDocumentMapper extends java.lang.Object implements DocumentMapper
DocumentMapper.SaveOpts, DocumentMapper.TextDocumentMenuIndexPair| Constructor and Description |
|---|
DefaultDocumentMapper(NativeQueries nativeQueries,
DocumentSaver documentSaver,
CategoryMapper categoryMapper,
DocumentContentMapper documentContentMapper,
MenuRepository menuRepository,
com.imcode.db.Database database,
DocumentLanguages languages,
PropertyService propertyService,
DocumentLoaderCachingProxy documentLoaderCachingProxy,
MenuService defaultMenuService) |
| Modifier and Type | Method and Description |
|---|---|
void |
changeDocumentDefaultVersion(int docId,
int newDocDefaultVersionNo,
UserDomainObject publisher)
Changes doc's default version.
|
<T extends DocumentDomainObject> |
copyDocument(T doc,
UserDomainObject user)
Creates a new doc as a copy of an existing doc.
|
DocumentDomainObject |
createDocumentOfTypeFromParent(int documentTypeId,
DocumentDomainObject parentDoc,
UserDomainObject user)
Creates new Document which inherits parent doc's meta excluding keywords and properties.
|
void |
deleteDocument(DocumentDomainObject document) |
void |
deleteDocument(int docId) |
java.util.List<java.lang.String> |
getAllDocumentAlias() |
java.util.List<java.lang.Integer> |
getAllDocumentIds() |
java.util.Map<java.lang.Integer,java.lang.String> |
getAllDocumentTypeIdsAndNamesInUsersLanguage(UserDomainObject user) |
CategoryMapper |
getCategoryMapper() |
java.util.Map<DocumentLanguage,DocumentCommonContent> |
getCommonContents(int docId,
int versionNo) |
<T extends DocumentDomainObject> |
getCustomDocument(DocRef docRef)
Returns custom document.
|
com.imcode.db.Database |
getDatabase() |
<T extends DocumentDomainObject> |
getDefaultDocument(int docId) |
<T extends DocumentDomainObject> |
getDefaultDocument(int docId,
DocumentLanguage language)
Returns default document
|
<T extends DocumentDomainObject> |
getDefaultDocument(int docId,
java.lang.String languageCode) |
<T extends DocumentDomainObject> |
getDocument(int docId)
Returns document.
|
DocumentDomainObject |
getDocument(java.lang.String documentIdentity) |
DocumentIndex |
getDocumentIndex() |
DocumentLanguages |
getDocumentLanguages() |
DocumentMapper.TextDocumentMenuIndexPair[] |
getDocumentMenuPairsContainingDocument(DocumentDomainObject document) |
DocumentReference |
getDocumentReference(DocumentDomainObject document) |
java.util.List<DocumentDomainObject> |
getDocuments(java.util.Collection<java.lang.Integer> documentIds) |
java.util.Iterator<DocumentDomainObject> |
getDocumentsIterator(org.apache.commons.lang.math.IntRange idRange) |
java.util.List<DocumentDomainObject> |
getDocumentsWithPermissionsForRole(RoleDomainObject role) |
DocumentVersionInfo |
getDocumentVersionInfo(int documentId) |
int |
getHighestDocumentId() |
int |
getLowestDocumentId() |
<T extends DocumentDomainObject> |
getVersionedDocument(java.lang.String documentIdentity,
java.lang.String langCode,
javax.servlet.ServletRequest request)
Get document version by document id or alias, parameters in request and language code
|
<T extends DocumentDomainObject> |
getWorkingDocument(int docId) |
<T extends DocumentDomainObject> |
getWorkingDocument(int docId,
DocumentLanguage language) |
void |
init() |
void |
invalidateDocument(DocumentDomainObject document) |
void |
invalidateDocument(int docId) |
DocumentVersion |
makeDocumentVersion(int docId,
UserDomainObject user)
Creates next document version.
|
int |
saveDocument(DocumentDomainObject doc,
java.util.Map<DocumentLanguage,DocumentCommonContent> commonContents,
UserDomainObject user)
Updates existing document.
|
int |
saveDocument(DocumentDomainObject doc,
UserDomainObject user)
Updates existing document.
|
<T extends DocumentDomainObject> |
saveNewDocument(T doc,
java.util.Map<DocumentLanguage,DocumentCommonContent> appearances,
UserDomainObject user)
Saves doc as new.
|
<T extends DocumentDomainObject> |
saveNewDocument(T doc,
UserDomainObject user)
Saves doc as new.
|
void |
saveTextDocText(TextDocTextContainer container,
UserDomainObject user)
Saves text and non-saved enclosing content loop the text may refer.
|
void |
setDocumentIndex(DocumentIndex documentIndex) |
java.lang.Integer |
toDocumentId(java.lang.String documentIdentity) |
public DefaultDocumentMapper(NativeQueries nativeQueries, DocumentSaver documentSaver, CategoryMapper categoryMapper, DocumentContentMapper documentContentMapper, MenuRepository menuRepository, com.imcode.db.Database database, DocumentLanguages languages, PropertyService propertyService, DocumentLoaderCachingProxy documentLoaderCachingProxy, MenuService defaultMenuService)
@PostConstruct public void init()
public DocumentVersionInfo getDocumentVersionInfo(int documentId)
getDocumentVersionInfo in interface DocumentMapperdocumentId - document id.public DocumentDomainObject createDocumentOfTypeFromParent(int documentTypeId, DocumentDomainObject parentDoc, UserDomainObject user)
DocumentMapperDoc's CommonContentJPA and content (texts, images, urls, files, etc) are not inherited.
createDocumentOfTypeFromParent in interface DocumentMapperpublic DocumentReference getDocumentReference(DocumentDomainObject document)
getDocumentReference in interface DocumentMapperpublic <T extends DocumentDomainObject> T saveNewDocument(T doc, UserDomainObject user) throws DocumentSaveException, NoPermissionToAddDocumentToMenuException
DocumentMappersaveNewDocument in interface DocumentMapperDocumentSaveExceptionNoPermissionToAddDocumentToMenuExceptionDocumentMapper.createDocumentOfTypeFromParent(int, DocumentDomainObject, UserDomainObject),
DocumentDomainObject.fromDocumentTypeId(int)public <T extends DocumentDomainObject> T saveNewDocument(T doc, java.util.Map<DocumentLanguage,DocumentCommonContent> appearances, UserDomainObject user) throws DocumentSaveException, NoPermissionToAddDocumentToMenuException
DocumentMapperAccording to the spec, new doc creation UI allows to provide i18nMeta texts in all languages available in the system. However, a DocumentDomainObject has one-to-one relationship with i18nMeta. To workaround this limitation and provide backward compatibility with legacy API, i18nMeta-s are passed in a separate parameter and doc's i18nMeta is ignored.
saveNewDocument in interface DocumentMapperDocumentSaveExceptionNoPermissionToAddDocumentToMenuExceptionpublic int saveDocument(DocumentDomainObject doc, UserDomainObject user) throws DocumentSaveException, NoPermissionToAddDocumentToMenuException, NoPermissionToEditDocumentException
DocumentMappersaveDocument in interface DocumentMapperDocumentSaveExceptionNoPermissionToAddDocumentToMenuExceptionNoPermissionToEditDocumentExceptionpublic int saveDocument(DocumentDomainObject doc, java.util.Map<DocumentLanguage,DocumentCommonContent> commonContents, UserDomainObject user) throws DocumentSaveException, NoPermissionToAddDocumentToMenuException, NoPermissionToEditDocumentException
DocumentMappersaveDocument in interface DocumentMapperDocumentSaveExceptionNoPermissionToAddDocumentToMenuExceptionNoPermissionToEditDocumentExceptionpublic DocumentVersion makeDocumentVersion(int docId, UserDomainObject user)
DocumentMapperSaves document's working version copy as next document version.
makeDocumentVersion in interface DocumentMapperpublic void changeDocumentDefaultVersion(int docId,
int newDocDefaultVersionNo,
UserDomainObject publisher)
DocumentMapperchangeDocumentDefaultVersion in interface DocumentMapperpublic void invalidateDocument(DocumentDomainObject document)
invalidateDocument in interface DocumentMapperpublic void invalidateDocument(int docId)
invalidateDocument in interface DocumentMapperpublic DocumentIndex getDocumentIndex()
getDocumentIndex in interface DocumentMapperpublic void setDocumentIndex(DocumentIndex documentIndex)
setDocumentIndex in interface DocumentMapperpublic void deleteDocument(int docId)
deleteDocument in interface DocumentMapperpublic void deleteDocument(DocumentDomainObject document)
deleteDocument in interface DocumentMapperpublic java.util.Map<java.lang.Integer,java.lang.String> getAllDocumentTypeIdsAndNamesInUsersLanguage(UserDomainObject user)
getAllDocumentTypeIdsAndNamesInUsersLanguage in interface DocumentMapperpublic DocumentMapper.TextDocumentMenuIndexPair[] getDocumentMenuPairsContainingDocument(DocumentDomainObject document)
getDocumentMenuPairsContainingDocument in interface DocumentMapperpublic java.util.Iterator<DocumentDomainObject> getDocumentsIterator(org.apache.commons.lang.math.IntRange idRange)
getDocumentsIterator in interface DocumentMapperpublic java.util.List<java.lang.Integer> getAllDocumentIds()
getAllDocumentIds in interface DocumentMapperpublic java.util.List<java.lang.String> getAllDocumentAlias()
getAllDocumentAlias in interface DocumentMapperpublic DocumentDomainObject getDocument(java.lang.String documentIdentity)
getDocument in interface DocumentMapperdocumentIdentity - document id or alias.public java.lang.Integer toDocumentId(java.lang.String documentIdentity)
toDocumentId in interface DocumentMapperdocumentIdentity - document id or aliaspublic int getLowestDocumentId()
getLowestDocumentId in interface DocumentMapperpublic int getHighestDocumentId()
getHighestDocumentId in interface DocumentMapperpublic <T extends DocumentDomainObject> T copyDocument(T doc, UserDomainObject user) throws NoPermissionToAddDocumentToMenuException, DocumentSaveException
DocumentMapperPlease note that provided document is not used as a new document prototype/template; it is used as a DTO to pass existing doc identities (id, version, language) to the method.
copyDocument in interface DocumentMapperdoc - existing doc.user - the userNoPermissionToAddDocumentToMenuExceptionDocumentSaveExceptionpublic java.util.List<DocumentDomainObject> getDocumentsWithPermissionsForRole(RoleDomainObject role)
getDocumentsWithPermissionsForRole in interface DocumentMapperpublic <T extends DocumentDomainObject> T getDefaultDocument(int docId)
getDefaultDocument in interface DocumentGettergetDefaultDocument in interface DocumentMapperdocId - document idpublic <T extends DocumentDomainObject> T getWorkingDocument(int docId)
getWorkingDocument in interface DocumentMapperdocId - document idpublic <T extends DocumentDomainObject> T getDocument(int docId)
DocumentMapperDelegates call to a callback associated with a user. If there is no callback then a default document is returned.
getDocument in interface DocumentGettergetDocument in interface DocumentMapperdocId - document id.public <T extends DocumentDomainObject> T getWorkingDocument(int docId, DocumentLanguage language)
getWorkingDocument in interface DocumentMapperdocId - document idlanguage - languagepublic <T extends DocumentDomainObject> T getDefaultDocument(int docId, DocumentLanguage language)
DocumentGettergetDefaultDocument in interface DocumentGettergetDefaultDocument in interface DocumentMapperdocId - document idlanguage - languagepublic <T extends DocumentDomainObject> T getDefaultDocument(int docId, java.lang.String languageCode)
getDefaultDocument in interface DocumentMapperdocId - document idlanguageCode - language codepublic <T extends DocumentDomainObject> T getCustomDocument(DocRef docRef)
Custom document is never cached.
getCustomDocument in interface DocumentMapperpublic CategoryMapper getCategoryMapper()
getCategoryMapper in interface DocumentMapperpublic com.imcode.db.Database getDatabase()
getDatabase in interface DocumentMapperpublic DocumentLanguages getDocumentLanguages()
getDocumentLanguages in interface DocumentMapperpublic void saveTextDocText(TextDocTextContainer container, UserDomainObject user) throws NoPermissionInternalException
DocumentMapperNon saved enclosing content loop might be added to the doc by ContentLoopTag2.
saveTextDocText in interface DocumentMappercontainer - - text being savedNoPermissionInternalExceptionpublic java.util.List<DocumentDomainObject> getDocuments(java.util.Collection<java.lang.Integer> documentIds)
getDocuments in interface DocumentGettergetDocuments in interface DocumentMapperdocumentIds - id's of documentspublic <T extends DocumentDomainObject> T getVersionedDocument(java.lang.String documentIdentity, java.lang.String langCode, javax.servlet.ServletRequest request)
DocumentMappergetVersionedDocument in interface DocumentMapperdocumentIdentity - document id or aliaspublic java.util.Map<DocumentLanguage,DocumentCommonContent> getCommonContents(int docId, int versionNo)
getCommonContents in interface DocumentMapper