org.efaps.update.schema.ui.AbstractCollectionUpdate Maven / Gradle / Ivy
/*
* Copyright 2003 - 2013 The eFaps Team
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Revision: $Rev: 8908 $
* Last Changed: $Date: 2013-02-20 16:18:41 -0500 (Wed, 20 Feb 2013) $
* Last Changed By: $Author: [email protected] $
*/
package org.efaps.update.schema.ui;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.efaps.admin.event.EventType;
import org.efaps.ci.CIAdminCommon;
import org.efaps.ci.CIAdminEvent;
import org.efaps.ci.CIAdminUserInterface;
import org.efaps.db.Delete;
import org.efaps.db.Insert;
import org.efaps.db.Instance;
import org.efaps.db.InstanceQuery;
import org.efaps.db.QueryBuilder;
import org.efaps.update.AbstractUpdate;
import org.efaps.update.LinkInstance;
import org.efaps.update.UpdateLifecycle;
import org.efaps.update.event.Event;
import org.efaps.update.util.InstallationException;
import org.efaps.util.EFapsException;
/**
* This class imports/updates a Form or a Table using the
* org.apache.commons.digester.Digester to create objects and to
* execute methods.
*
* @author The eFaps Team
* @version $Id: AbstractCollectionUpdate.java 8908 2013-02-20 21:18:41Z [email protected] $
*
*/
public abstract class AbstractCollectionUpdate
extends AbstractUpdate
{
/** Link from field to icon. */
private static final Link LINKFIELD2ICON = new Link("Admin_UI_LinkIcon", "From", "Admin_UI_Image", "To");
/** Link from field to table as target. */
private static final Link LINK2TARGETTABLE = new Link("Admin_UI_LinkTargetTable", "From", "Admin_UI_Table", "To");
/** Link from field to command as picker. */
private static final Link LINK2PICKER = new Link("Admin_UI_LinkField2Command", "FromLink",
"Admin_UI_Command", "ToLink");
/**
* @param _url URL of the file
* @param _typeName name of the type
*/
protected AbstractCollectionUpdate(final URL _url,
final String _typeName)
{
super(_url, _typeName);
}
/**
* @param _url url of the file
* @param _typeName name of the type
* @param _allLinkTypes set of all links
*/
protected AbstractCollectionUpdate(final URL _url,
final String _typeName,
final Set _allLinkTypes)
{
super(_url, _typeName, _allLinkTypes);
}
/**
* Creates new instance of class {@link Definition}.
*
* @return new definition instance
* @see Definition
*/
@Override
protected AbstractDefinition newDefinition()
{
return new Definition();
}
/**
* Class for defining a field.
*/
private final class FieldDefinition
extends AbstractDefinition
{
/** Name of the field. */
private final String name;
/** Icon of the field. */
private String icon = null;
/** set the character of the field. */
private final String character;
/**
*
* @param _name Name of the field
* @param _character charachter of the field
*/
private FieldDefinition(final String _name,
final String _character)
{
this.name = _name;
this.character = _character;
}
/**
* {@inheritDoc}
*/
@Override
protected void readXML(final List _tags,
final Map _attributes,
final String _text)
{
final String value = _tags.get(0);
if ("evaluate".equals(value)) {
if (_tags.size() == 1) {
getEvents().add(new Event(_attributes.get("name"), EventType.UI_TABLE_EVALUATE, _attributes
.get("program"), _attributes.get("method"), _attributes.get("index")));
} else if ((_tags.size() == 2) && "property".equals(_tags.get(1))) {
getEvents().get(getEvents().size() - 1).addProperty(_attributes.get("name"), _text);
} else {
super.readXML(_tags, _attributes, _text);
}
} else if ("icon".equals(value)) {
this.icon = _text;
} else if ("table".equals(value)) {
// assigns a table as target for this field definition
addLink(AbstractCollectionUpdate.LINK2TARGETTABLE, new LinkInstance(_text));
} else if ("picker".equals(value)) {
// assigns a picker as target for this field definition
addLink(AbstractCollectionUpdate.LINK2PICKER, new LinkInstance(_attributes.get("name")));
} else if ("trigger".equals(value)) {
if (_tags.size() == 1) {
getEvents().add(new Event(_attributes.get("name"), EventType.valueOf(_attributes.get("event")),
_attributes.get("program"), _attributes.get("method"), _attributes.get("index")));
} else if ((_tags.size() == 2) && "property".equals(_tags.get(1))) {
getEvents().get(getEvents().size() - 1).addProperty(_attributes.get("name"), _text);
} else {
super.readXML(_tags, _attributes, _text);
}
} else {
super.readXML(_tags, _attributes, _text);
}
}
/**
* Returns a string representation with values of all instance variables
* of a field.
*
* @return string representation of this definition of a column
*/
@Override
public String toString()
{
return new ToStringBuilder(this).append("name", this.name).append("properties", getProperties()).toString();
}
}
/**
* Class used to define a collection.
*
*/
protected class Definition
extends AbstractDefinition
{
/** All fields for the collection are stored in this variable. */
private final List fields
= new ArrayList();
/**
* Current read field definition.
*
* @see #readXML(List, Map, String)
*/
private FieldDefinition curField = null;
/**
* @see org.efaps.update.AbstractUpdate.AbstractDefinition#readXML(java.util.List,
* java.util.Map, java.lang.String)
* @param _tags tags
* @param _attributes attributes
* @param _text text
*/
@Override
protected void readXML(final List _tags,
final Map _attributes,
final String _text)
{
final String value = _tags.get(0);
if ("field".equals(value)) {
if (_tags.size() == 1) {
this.curField = new FieldDefinition(_attributes.get("name"), _attributes.get("character"));
this.fields.add(this.curField);
} else {
this.curField.readXML(_tags.subList(1, _tags.size()), _attributes, _text);
}
} else {
super.readXML(_tags, _attributes, _text);
}
}
/**
* Updates / creates the instance in the database. Only the fields are
* also updated for collection defined through this definition.
*
* @param _step current update step
* @param _allLinkTypes set of all type of links
* @throws InstallationException on error
* @see #setFieldsInDB
*/
@Override
public void updateInDB(final UpdateLifecycle _step,
final Set _allLinkTypes)
throws InstallationException
{
super.updateInDB(_step, _allLinkTypes);
if (_step == UpdateLifecycle.EFAPS_UPDATE) {
try {
setFieldsInDB();
} catch (final EFapsException e) {
throw new InstallationException("error in setFieldsInDB", e);
}
}
}
/**
* The fields for this collection are created and / or updated in the
* database.
* TODO the deletion of existing fields is nested! Thats not
* the best idea.
*
* @throws EFapsException on error
*/
protected void setFieldsInDB()
throws EFapsException
{
// cleanup fields (remove all fields from table)
final QueryBuilder queryBldr = new QueryBuilder(CIAdminUserInterface.Field);
queryBldr.addWhereAttrEqValue(CIAdminUserInterface.Field.Collection, getInstance().getId());
final InstanceQuery query = queryBldr.getQuery();
query.executeWithoutAccessCheck();
while (query.next()) {
final Instance field = query.getCurrentValue();
setPropertiesInDb(field, null);
removeLinksInDB(field, AbstractCollectionUpdate.LINKFIELD2ICON);
removeLinksInDB(field, AbstractCollectionUpdate.LINK2TARGETTABLE);
removeLinksInDB(field, AbstractCollectionUpdate.LINK2PICKER);
// remove events
final QueryBuilder eventQueryBldr = new QueryBuilder(CIAdminEvent.Definition);
eventQueryBldr.addWhereAttrEqValue(CIAdminEvent.Definition.Abstract, field.getId());
final InstanceQuery eventQuery = eventQueryBldr.getQuery();
eventQuery.execute();
while (eventQuery.next()) {
final Instance event = eventQuery.getCurrentValue();
final QueryBuilder propQueryBldr = new QueryBuilder(CIAdminCommon.Property);
propQueryBldr.addWhereAttrEqValue(CIAdminCommon.Property.Abstract, event.getId());
final InstanceQuery propQuery = propQueryBldr.getQuery();
propQuery.execute();
while (propQuery.next()) {
new Delete(propQuery.getCurrentValue()).executeWithoutAccessCheck();
}
new Delete(event).executeWithoutAccessCheck();
}
new Delete(field).executeWithoutAccessCheck();
}
// append new fields
for (final FieldDefinition field : this.fields) {
Insert insert;
if ("Command".equals(field.character)) {
insert = new Insert(CIAdminUserInterface.FieldCommand);
} else if ("Target".equals(field.character)) {
insert = new Insert(CIAdminUserInterface.FieldTable);
} else if ("Heading".equals(field.character)) {
insert = new Insert(CIAdminUserInterface.FieldHeading);
} else if ("Group".equals(field.character)) {
insert = new Insert(CIAdminUserInterface.FieldGroup);
} else if ("Set".equals(field.character)) {
insert = new Insert(CIAdminUserInterface.FieldSet);
} else if ("Classification".equals(field.character)) {
insert = new Insert(CIAdminUserInterface.FieldClassification);
} else if ("Picker".equals(field.character)) {
insert = new Insert(CIAdminUserInterface.FieldPicker);
} else if ("Chart".equals(field.character)) {
insert = new Insert(CIAdminUserInterface.FieldChart);
} else {
insert = new Insert(CIAdminUserInterface.Field);
}
insert.add("Collection", getInstance().getId());
insert.add("Name", field.name);
insert.executeWithoutAccessCheck();
setPropertiesInDb(insert.getInstance(), field.getProperties());
if (field.icon != null) {
final Set iconset = new HashSet();
iconset.add(new LinkInstance(field.icon));
setLinksInDB(insert.getInstance(), AbstractCollectionUpdate.LINKFIELD2ICON, iconset);
}
// link to table
setLinksInDB(insert.getInstance(), AbstractCollectionUpdate.LINK2TARGETTABLE,
field.getLinks(AbstractCollectionUpdate.LINK2TARGETTABLE));
// link to picker
setLinksInDB(insert.getInstance(), AbstractCollectionUpdate.LINK2PICKER,
field.getLinks(AbstractCollectionUpdate.LINK2PICKER));
// append events
for (final Event event : field.getEvents()) {
final Instance newInstance = event.updateInDB(insert.getInstance(), field.name);
setPropertiesInDb(newInstance, event.getProperties());
}
}
}
/**
* Adds a new field to this definition of the table.
*
* @param _field new field to add to this table
* @see #fields
*/
public void addField(final FieldDefinition _field)
{
this.fields.add(_field);
}
/**
* Returns a string representation with values of all instance variables
* of a field.
*
* @return string representation of this definition of a column
*/
@Override
public String toString()
{
return new ToStringBuilder(this).appendSuper(super.toString()).append("fields", this.fields).toString();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy