Source/UBCS/ubcs-service/ubcs-ddl/src/main/java/com/vci/ubcs/ddl/service/IDdlService.java

¶Ô±ÈÐÂÎļþ
@@ -0,0 +1,249 @@
package com.vci.ubcs.ddl.service;

import com.vci.ubcs.ddl.bo.DdlTableBO;
import com.vci.ubcs.omd.dto.BtmAndLinkTypeDdlDTO;
import com.vci.ubcs.omd.dto.BtmTypeDTO;
import com.vci.ubcs.omd.entity.ModifyAttributeInfo;
import com.vci.ubcs.omd.vo.BtmTypeAttributeVO;
import com.vci.ubcs.omd.vo.BtmTypeVO;
import com.vci.ubcs.omd.vo.LinkTypeAttributeVO;
import com.vci.ubcs.omd.vo.LinkTypeVO;
import com.vci.ubcs.starter.exception.VciBaseException;
import org.springblade.core.tool.api.R;

import java.util.Collection;
import java.util.List;

/**
 * Description: æ•°æ®åº“操作服务类
 *  æ³¨æ„çš„是，oracle对于DDL操作都会先提交一次事务，当执行完成后会再次提交一次事务
 *
 * @author LiHang
 * @date 2023/4/24
 */
public interface IDdlService {

   /**
    * æ ¡éªŒä¸šåŠ¡ç±»åž‹çš„数据库表中是否有数据
    * @param pkBtmType ä¸šåŠ¡ç±»åž‹çš„主键
    * @return true表示有数据，false表示没有数据
    * @throws VciBaseException å‚数为空或者查询出错的时候会抛出异常
    */
   boolean checkTableHasData(String pkBtmType) throws VciBaseException;

   /**
    * æ ¹æ®ä¸šåŠ¡ç±»åž‹æˆ–者链接类型的主键获取数据库表格的名称
    * @param pkBtmType  ä¸šåŠ¡ç±»åž‹æˆ–者链接类型的主键
    * @return æ•°æ®åº“表名称
    */
   String getTableNameByBtmTypeOid(String pkBtmType);

   /**
    * æ ¹æ®ä¸šåŠ¡ç±»åž‹èŽ·å–链接类型的英文名称获取数据库表格的名称
    * @param id ä¸šåŠ¡ç±»åž‹èŽ·å–链接类型的英文名称
    * @return æ•°æ®åº“表名称
    */
   String getTableNameByBtmTypeId(String id);

   /**
    * æ ¡éªŒä¸šåŠ¡ç±»åž‹çš„数据库表中是否有数据
    * @param id ä¸šåŠ¡ç±»åž‹çš„英文名称
    * @return true表示有数据，false表示没有数据
    * @throws VciBaseException å‚数为空或者查询出错的时候会抛出异常
    */
   boolean checkTableHasDataById(String id) throws VciBaseException;

   /**
    * æ‰¹é‡å°†ä¸šåŠ¡ç±»åž‹åˆ›å»ºæ•°æ®åº“表
    * @param pkBtmTypes ä¸šåŠ¡ç±»åž‹çš„主键
    * @throws VciBaseException å‚数为空或者创建表出现了错误的时候会抛出异常
    */
   void createDbTables(String pkBtmTypes) throws VciBaseException;

   /**
    * æ‰¹é‡å°†ä¸šåŠ¡ç±»åž‹åˆ›å»ºæ•°æ®åº“表
    * @param oidCollection ä¸šåŠ¡ç±»åž‹çš„主键集合
    * @throws VciBaseException å‚数为空或者创建表出现了错误的时候会抛出异常
    */
   void createDbTablesByOidCollection(Collection<String> oidCollection) throws VciBaseException;

   /**
    * èŽ·å–创建的sql语句中属性部分
    * @param attributeVOList å±žæ€§çš„立碑
    * @return sql语句
    */
   String getCreateSqlByAttributeForBtm(List<BtmTypeAttributeVO> attributeVOList);

   /**
    * æ‰¹é‡å°†ä¸šåŠ¡ç±»åž‹åˆ›å»ºæ•°æ®åº“表
    * @param ids ä¸šåŠ¡ç±»åž‹çš„英文名称
    * @throws VciBaseException å‚数为空或者创建表出现了错误的时候会抛出异常
    */
   void createDbTablesById(String ids) throws VciBaseException;

   /**
    * ä¿®æ”¹ä¸šåŠ¡ç±»åž‹ä¸­çš„属性字段的长度，注意在执行这个方法时就会将以前的事务提交。
    * @param modifyLengthAttrDOList éœ€è¦ä¿®æ”¹çš„属性对象
    * @throws VciBaseException æ‰§è¡Œå‡ºé”™çš„时候会抛出异常
    */
   void changeColumnForBtm(List<BtmTypeAttributeVO> modifyLengthAttrDOList) throws VciBaseException;

   /**
    * ä¿®æ”¹é“¾æŽ¥ç±»åž‹ä¸­çš„属性字段的长度，注意在执行这个方法时就会将以前的事务提交。
    * @param modifyLengthAttrDOListForLinkType éœ€è¦ä¿®æ”¹çš„属性对象
    * @throws VciBaseException æ‰§è¡Œå‡ºé”™çš„时候会抛出异常
    */
   void changeColumnForLink(List<LinkTypeAttributeVO> modifyLengthAttrDOListForLinkType) throws VciBaseException;

   /**
    * æ·»åŠ å±žæ€§å­—段到业务类型中，注意在执行这个方法时就会将以前的事务提交。
    * @param addAttrDOList éœ€è¦æ·»åŠ çš„属性对象
    * @throws VciBaseException æ‰§è¡Œå‡ºé”™çš„时候会抛出异常
    */
   void addColumn2TableForBtm(List<BtmTypeAttributeVO> addAttrDOList) throws VciBaseException;

   /**
    * æ·»åŠ å±žæ€§å­—段到链接类型中，注意在执行这个方法时就会将以前的事务提交。
    * @param addAttrDOListForLinkType éœ€è¦æ·»åŠ çš„属性对象
    * @throws VciBaseException æ‰§è¡Œå‡ºé”™çš„时候会抛出异常
    */
   void addColumn2TableForLink(List<LinkTypeAttributeVO> addAttrDOListForLinkType) throws VciBaseException;

   /**
    * åˆ¤æ–­è¡¨ä¸­æ˜¯å¦æœ‰æ•°æ®
    * @param tableName è¡¨æ ¼çš„名称
    * @return true表示有数据，false表示没有数据，或者这个表格不存在的时候抛出异常
    * @throws VciBaseException å‚数错误的时候抛出异常
    */
   boolean checkTableHasDataByTableName(String tableName)  throws VciBaseException;

   /**
    * åˆ›å»ºè§†å›¾
    * @param viewCreateSql è§†å›¾çš„SQL语句
    * @throws VciBaseException å‚数错误或者执行错误的时候会抛出异常，执行错误主要包括SQL语句错误，没有权限等
    */
   void createViewBySql(String viewCreateSql) throws VciBaseException;

   /**
    * åˆ é™¤è¡¨æ ¼æˆ–者视图
    * @param tableName è¡¨æ ¼åç§°æˆ–者视图名称
    * @throws VciBaseException å‚数错误或者执行错误的时候会抛出异常
    */
   void dropTableByName(String tableName) throws VciBaseException;
   /**
    * åˆ é™¤è¡¨æ ¼çš„某一列
    * @param tableName è¡¨æ ¼åç§°
    * @param columnName åˆ—的名称
    */
   void dropColumnByName(String tableName, String columnName);

   /**
    * æ ¡éªŒä¸šåŠ¡ç±»åž‹æˆ–者链接类型的对应的表格是否存在
    * @param pkBtmType ä¸šåŠ¡ç±»åž‹æˆ–者链接类型的表格
    * @return true表示存在，false表示不存在
    */
   boolean checkTableExist(String pkBtmType);

   /**
    * æ ¹æ®è¡¨æ ¼çš„名称判断表格是否存在
    * @param tableName è¡¨æ ¼åç§°
    * @return  rue表示存在，false表示不存在
    */
   boolean checkTableExistByTableName(String tableName);

   /**
    * æ ¡éªŒä¸šåŠ¡ç±»åž‹æˆ–者链接类型所对应的表格是否存在
    * @param id ä¸šåŠ¡ç±»åž‹æˆ–者链接类型的英文名称
    * @return true表示存在，false表示不存在
    */
   boolean checkTableExistById(String id);

   /**
    * èŽ·å–数据库和业务类型中的不同的地方
    * @param btmTypeVOList ä¸šåŠ¡ç±»åž‹å¯¹è±¡ï¼Œæœ‰å±žæ€§æ—¶éœ€è¦åŒ…含属性
    * @param linkTypeVOList é“¾æŽ¥ç±»åž‹å¯¹è±¡ï¼Œæœ‰å±žæ€§æ—¶éœ€è¦åŒ…含属性
    * @return ä¸åŒçš„地方，每一个业务类型或者链接类型一条数据
    */
   List<ModifyAttributeInfo> checkDifferent(List<BtmTypeVO> btmTypeVOList, List<LinkTypeVO> linkTypeVOList) throws VciBaseException;

   /**
    * æ¸…理业务类型中和数据库里不一样的
    * @param differentAttributeList ä¸åŒçš„属性的列表
    * @param btmTypeVOList ä¸šåŠ¡ç±»åž‹æ•°æ®
    * @param linkTypeVOList é“¾æŽ¥ç±»åž‹æ•°æ®
    * @throws VciBaseException å‚数为空或者执行出错的时候会抛出异常
    */
   void reflexDifferent(List<ModifyAttributeInfo> differentAttributeList,List<BtmTypeVO> btmTypeVOList, List<LinkTypeVO> linkTypeVOList) throws VciBaseException;

   /**
    * èŽ·å–数据库中所有的表格
    * @return è¡¨æ ¼çš„名称，全是大写
    */
   List<String> listAllTableName() ;

   /**
    * æŸ¥è¯¢æ•°æ®åº“中的表格信息
    * @param tableNamesCollections æ•°æ®åº“表名集合
    * @return åœ¨æ•°æ®åº“中的信息
    * @throws VciBaseException å‚数为空或者数据库表不存在的时候会抛出异常
    */
   List<DdlTableBO> listTableInfoInDB(Collection<String> tableNamesCollections) throws VciBaseException;

   /**
    * å¯¼å‡ºæ•°æ®åº“中的表格信息到excel文件
    * @param tableNamesCollections è¡¨æ ¼åç§°çš„集合
    * @param merge åˆå¹¶è¡¨æ ¼åç§°
    * @return excel的文件名称
    * @throws VciBaseException èš•é£Ÿä¸ºç©ºæˆ–者数据库表不存在的时候会抛出异常
    */
   String exportDataBase2File(Collection<String> tableNamesCollections,boolean merge) throws VciBaseException;

   /**
    * èŽ·å–存储文件所需要的临时文件夹，文件夹上已经包含了
    * @return æ–‡ä»¶å¤¹çš„地址，如果配置文件没有配置，则默认返回当前项目所在的文件夹
    */
   String getTempFolder();

   /**
    * å¯¼å‡ºæ•°æ®åº“中的表格信息到word文件中
    * @param tableNamesCollections è¡¨æ ¼åç§°çš„集合
    * @return word的文件名称
    * @throws VciBaseException èš•é£Ÿä¸ºç©ºæˆ–者数据库表不存在的时候会抛出异常
    */
   String exportDataBase2Word(List<String> tableNamesCollections) throws VciBaseException;

   /**
    * æ‹·è´æ•°æ®åˆ°word模板中
    * @param tableDataBO è¦å†™å…¥çš„数据
    * @return word æ–‡ä»¶è·¯å¾„
    *//*
   String writeDataToWord(WordMergeStartTableDataBO tableDataBO);*/

   /**
    * åˆ¤æ–­æ˜¯å¦ä¸ºå…¼å®¹æ€§çš„表，这些表不应该被创建和修改
    * @param btmTypeId ä¸šåŠ¡ç±»åž‹çš„英文名称
    * @param linkTypeId ä¸šåŠ¡ç±»åž‹çš„中文名称
    * @return true è¡¨ç¤ºä¸ºå…¼å®¹æ€§çš„表，用户，角色，部门，权限这些
    */
   boolean isCompatibilityTable(String btmTypeId,String linkTypeId);

   /**
    * æ•°æ®åº“新增或修改表
    * @param ddlDTO ä¸šåŠ¡ç±»åž‹ä¼ è¾“对象
    * @return æ‰§è¡Œç»“æžœ
    */
   R submit(BtmAndLinkTypeDdlDTO ddlDTO);

   /**
    * æŒ‰è¡¨åèŽ·å–表信息
    * @param tableName è¡¨å
    * @return è¡¨ä¿¡æ¯
    */
   DdlTableBO getTableColumnByTableName(String tableName);

   /**
    * èŽ·å–所有表信息
    * @return è¡¨ä¿¡æ¯é›†åˆ
    */
   List<BtmTypeVO> getAllTableInfo();
}