openmind: src/main/java/org/mpi/openmind/repository/services/AbstractPersistenceService.java comparison

comparison src/main/java/org/mpi/openmind/repository/services/AbstractPersistenceService.java @ 33:e52f593f9e0d

new transaction logger "openmind.transactionlog" logging entity save actions and their data. more comments in code.

author	casties
date	Fri, 26 Aug 2016 11:42:41 +0200
parents	8ea716da439f
children	5737ab564b94

comparison

equal deleted inserted replaced

-:9c54842f5e86
+:e52f593f9e0d
 *
 * @author jurzua
 */
 public abstract class AbstractPersistenceService {
-	private ConfigurationService configurationService;
+private ConfigurationService configurationService;
 	private OwnValueGenerator ownValueGenerator;
 	private final static String NODE_SEQUENCE = "nodeSequence";
-	private static Logger logger = Logger
+	private static Logger logger = Logger.getLogger(AbstractPersistenceService.class);
-			.getLogger(AbstractPersistenceService.class);
+public static final String TRANSACTION_LOGGER = "openmind.transactionlog";
-	private boolean importModus = false;
+private static Logger txLog = Logger.getLogger(TRANSACTION_LOGGER);
+	private boolean importMode = false;
 	/*
 	 * static { logger.setLevel(Level.DEBUG); PatternLayout layout = new
 	 * PatternLayout( "%d{ABSOLUTE} %5p %c{1}:%L - %m%n"); Appender stdout = new
 	 * ConsoleAppender(layout, "System.out"); logger.addAppender(stdout); }
 							.println("[PersistenceService.saveEntity] found more than one current entities!");
 				}
 				Entity previousEntity = previousEntityList.get(0);
 				logger.info("Saving previous entity: " + previousEntity);
-				this.savePreviousEntity(session, previousEntity);
+				this.persistEntityAsPrevious(session, previousEntity);
 			}
 		}
 		session.getTransaction().commit();
 	}
-	/*
-	 * public void removeEntity(Long entId, String type) {
+	/**
-	 * logger.info("Deleting entity [ID=" + entId + ", type=" + type +
+	 * Save the entity to the database.
-	 * "]. But keeping history in DB."); Session session =
+	 *
-	 * HibernateUtil.getSessionFactory().getCurrentSession();
+	 * Creates a new version of the entity. Runs in a transaction.
-	 * session.getTransaction().begin();
+	 *
-	 *
+	 * @param entity
-	 * if (entId != null) { List<Entity> previousEntityList =
+	 * @return
-	 * this.getEntities(session, entId, Node.SYS_STATUS_CURRENT_VERSION, type,
+	 */
-	 * null); if (previousEntityList.size() > 0) { if (previousEntityList.size()
+	public void saveEntity(Entity entity) throws Exception {
-	 * > 1) { System.err .println(
-	 * "[PersistenceService.saveEntity] found more than one current entities!");
-	 * }
-	 *
-	 * Entity previousEntity = previousEntityList.get(0);
-	 * logger.info("Saving previous entity: " + previousEntity);
-	 * this.savePreviousEntity(session, previousEntity); } } }
-	 */
-	public void savePreviousEntity(Entity entity) throws Exception {
 		Session session = HibernateUtil.getSessionFactory().getCurrentSession();
 		session.getTransaction().begin();
-		if (entity.getId() != null) {
+		saveEntity0(session, entity);
-			List<Entity> previousEntityList = this.getEntities(session,
-					entity.getId(), Node.SYS_STATUS_CURRENT_VERSION,
-					entity.getType(), null, false);
-			if (previousEntityList.size() > 0) {
-				if (previousEntityList.size() > 1) {
-					logger.error("[PersistenceService.saveEntity] found more than one current entities!");
-				}
-				Entity previousEntity = previousEntityList.get(0);
-				logger.debug("Saving previous entity: " + previousEntity);
-				this.savePreviousEntity(session, previousEntity);
-			}
-		}
-		this.saveCurrentEntity(session, entity, null);
 		session.getTransaction().commit();
-	}
+	}
-	/**
-	 *
+	/**
+	 * Save the entity to the database using the given session.
+	 *
+	 * Creates a new version and sets the existing entity to PREVIOUS_VERSION.
+	 *
+	 * @param session
 	 * @param entity
-	 * @return
+	 * @throws Exception
 	 */
-	public void saveEntity(Entity entity) throws Exception {
-		Session session = HibernateUtil.getSessionFactory().getCurrentSession();
-		session.getTransaction().begin();
-		saveEntity0(session, entity);
-		session.getTransaction().commit();
-	}
 	private void saveEntity0(Session session, Entity entity) throws Exception {
 		if (entity.getId() != null) {
 			List<Entity> previousEntityList = this.getEntities(session, entity.getId(), Node.SYS_STATUS_CURRENT_VERSION, entity.getType(), null, false);
 			if (previousEntityList.size() > 0) {
 				if (previousEntityList.size() > 1) {
 					logger.error("[PersistenceService.saveEntity] found more than one current entities!");
 				}
 				Entity previousEntity = previousEntityList.get(0);
 				logger.info("Saving previous entity: " + previousEntity);
-				this.savePreviousEntity(session, previousEntity);
+				this.persistEntityAsPrevious(session, previousEntity);
 			}
 		}
 		this.saveCurrentEntity(session, entity, null);
 	}
+	/**
+	 * Save the entity as (new) current version using the given session.
+	 *
+	 * Sets system_status to CURRENT_VERSION and updates row_id, version, modification_time,
+	 * etc.
+	 *
+	 * @param session
+	 * @param entity
+	 * @param idSequence
+	 * @throws Exception
+	 */
 	private void saveCurrentEntity(Session session, Entity entity,
 			Sequence idSequence) throws Exception {
 		Long time = System.currentTimeMillis();
 		entity.setSystemStatus(Node.SYS_STATUS_CURRENT_VERSION);
 		entity.resetRowId();
 		entity.setType(entity.getType());
 		entity.setUser(entity.getUser());
 		entity.autoNormalize();
 		// generating of id, connecting rels, atts and views to the entity
 		this.prepareEntity(session, entity, idSequence);
-		this.saveEntity(session, entity);
+		this.persistEntity(session, entity);
 	}
 	/**
-	 * Here the modification time will be propagated from the entity to its
+	 * Update the entity to prepare it for persisting.
-	 * relations an attributes.
+	 *
+	 * If the ID is null new IDs will be assigned for the entity and its
+	 * attributes and relations.
+	 * The modification time is propagated from the entity to its
+	 * attributes and relations.
+	 * Own-values are normalized.
 	 *
 	 * @param session
 	 * @param entity
 	 * @return
 	 */
 		}
 		return entity;
 	}
 	/**
-	 * Saves an entity setting its system state as previous_version
+	 * Set an entities' system state to PREVIOUS_VERSION and persist it.
+	 *
+	 * Also persists the entities' attributes and relations.
 	 *
 	 * @param session
 	 * @param entity
 	 */
-	private void savePreviousEntity(Session session, Entity entity) {
+	private void persistEntityAsPrevious(Session session, Entity entity) {
 		entity.setSystemStatus(Node.SYS_STATUS_PREVIOUS_VERSION);
+txLog.debug("* START save previous entity...");
+txLog.info("save previous entity: "+entity.toEncString());
 		session.save(entity);
 		for (Attribute attribute : entity.getAttributes()) {
-logger.debug("  saving prev entity attribute: "+attribute);
+txLog.info("save previous entity attribute: "+attribute.toEncString());
 			session.save(attribute);
 		}
 		for (Relation rel : entity.getSourceRelations()) {
+	        txLog.info("save previous source relation: "+rel.toEncString());
 			session.save(rel);
 			for (Attribute att : rel.getAttributes()) {
-	            logger.debug("  saving prev (source)relation attribute: "+rel);
+txLog.info("save previous source relation attribute: "+att.toEncString());
 				session.save(att);
 			}
 		}
 		for (Relation rel : entity.getTargetRelations()) {
+txLog.info("save previous target relation: "+rel.toEncString());
 			session.save(rel);
 for (Attribute att : rel.getAttributes()) {
-logger.debug("  saving prev (target)relation attribute: "+rel);
+txLog.info("save previous target relation attribute: "+att.toEncString());
 session.save(att);
 }
 		}
 		for (View view : entity.getViews()) {
 			session.save(view);
 		}
-	}
+txLog.debug("* End ...save previous entity");
+	}
-	private void saveEntity(Session session, Entity entity) throws Exception {
-		logger.info("Saving current entity: " + entity);
+	/**
+	 * Persist a (current) entity and its attributes and relations.
+	 *
+	 * @param session
+	 * @param entity
+	 * @throws Exception
+	 */
+	private void persistEntity(Session session, Entity entity) throws Exception {
+		txLog.info("* START save entity...");
+txLog.info("save entity: "+entity.toEncString());
 		session.save(entity);
 		for (Attribute attribute : entity.getAttributes()) {
-		    logger.debug("  saving entity attribute: "+attribute);
+		    txLog.info("save entity attribute: "+attribute.toEncString());
 			session.save(attribute);
 		}
 		for (Relation rel : entity.getSourceRelations()) {
 			rel.setSource(entity);
 			if (rel.getSourceId() == null || rel.getTargetId() == null) {
 				throw new IllegalStateException(
 						"Either the sourceId or the targetId was not initialized to the source relation: "
 								+ rel.getOwnValue());
 			}
+	        txLog.info("save source relation: "+rel.toEncString());
 			session.save(rel);
 			for (Attribute att : rel.getAttributes()) {
-	            logger.debug("  saving (source)relation attribute: "+att);
+	            txLog.info("save source relation attribute: "+att.toEncString());
 				session.save(att);
 			}
 		}
 		for (Relation rel : entity.getTargetRelations()) {
 			rel.setTarget(entity);
 			if (rel.getSourceId() == null || rel.getTargetId() == null) {
 				throw new IllegalStateException(
 						"Either the sourceId or the targetId was not initialized to the target relation: "
 								+ rel.getOwnValue());
 			}
+txLog.info("save target relation: "+rel.toEncString());
 			session.save(rel);
 for (Attribute att : rel.getAttributes()) {
-logger.debug("  saving (target)relation attribute: "+att);
+txLog.info("save target relation attribute: "+att.toEncString());
 session.save(att);
 }
 		}
 		// Call of ownValue Generator.
 		// TODO: the method should be used always? what would happen if the
 		// ownValue returns null?
-		if (!isImportModus()) {
+		if (!isImportMode()) {
-			String ownValue = this.getOwnValueGenerator().generateOwnValue(
+			String ownValue = this.getOwnValueGenerator().generateOwnValue(entity, session);
-					entity, session);
 			if (StringUtils.isNotEmpty(ownValue)) {
 				entity.setOwnValue(ownValue);
 				entity.autoNormalize();
 				session.save(entity);
 			}
 		}
+txLog.debug("* ...END save entity");
 	}
 	public OwnValueGenerator getOwnValueGenerator() {
 		return ownValueGenerator;
 	}
 		this.ownValueGenerator = ownValueGenerator;
 	}
 	/**
 	 * <p>
-	 * Returns entities with their corresponded contain.
+	 * Returns entities with their corresponding contents.
 	 * </p>
 	 *
 	 * @param session
 	 * @param id
 	 * @param systemStatus
 		return entities;
 	}
 	/**
 	 * <p>
-	 * Returns entities with their corresponded contain.
+	 * Returns entities with their corresponding content.
 	 * </p>
 	 *
 	 * @param id
 	 * @param systemStatus
 	 * @param type
 			entity.setLightweight(false);
 			entity.setAttributes(new ArrayList<Attribute>());
 			entity.setSourceRelations(new ArrayList<Relation>());
 			entity.setTargetRelations(new ArrayList<Relation>());
-// FIXME: getNodes finds all attributes if id=null!
+/*
+* Danger: getNodes finds all attributes in the db and tries to attach them to
+* this entity if id=null!
+*/
 if (entity.getId() == null) {
 logger.error("Entity with id=null! Abort loading attributes.");
 return entity;
 }
 				if (node instanceof Attribute) {
 					entity.addAttribute((Attribute) node);
 				} else if (node instanceof Relation) {
 					Relation rel = (Relation) node;
 					// new attr for relations
-					// FIXME: getNodes finds all attributes if id=null!
+		            /*
+		             * Danger: getNodes finds all attributes in the db and tries to attach them to
+		             * this relation if id=null!
+		             */
 		            if (rel.getId() == null) {
 		                logger.error("Relation with id=null! Abort loading attributes.");
 		                continue;
 		            }
 					List<Node> attrs = this.getNodes(session, null,
 						entity.getSourceRelations().add(rel);
 					}
 				} else if (node instanceof View) {
 					entity.getViews().add((View) node);
 				} else {
-					throw new IllegalArgumentException("Invalid node found: "
+					throw new IllegalArgumentException("Invalid node found: " + node);
-							+ node);
 				}
 			}
 			// getting TargetRelations
 			List<Node> tarRels = null;
 			for (Node node : tarRels) {
 				if (node instanceof Relation) {
 					Relation rel = (Relation) node;
 					// new attr for relations
-		            // FIXME: getNodes finds all attributes if id=null!
+		            /*
+		             * Danger: getNodes finds all attributes in the db and tries to attach them to
+		             * this relation if id=null!
+		             */
 		            if (rel.getId() == null) {
 		                logger.error("Relation with id=null! Abort loading attributes.");
 		                continue;
 		            }
 					List<Node> attrs = this.getNodes(session, null,
 	public void setConfigurationService(
 			ConfigurationService configurationService) {
 		this.configurationService = configurationService;
 	}
-	public boolean isImportModus() {
+	public boolean isImportMode() {
-		return importModus;
+		return importMode;
 	}
 	public void setImportModus(boolean importModus) {
-		this.importModus = importModus;
+		this.importMode = importModus;
 	}
 	// #################################################################
 	// #################################################################
 	// #################################################################

Mercurial > hg > openmind

comparison src/main/java/org/mpi/openmind/repository/services/AbstractPersistenceService.java @ 33:e52f593f9e0d