/**
*
* @author Daniel Brunier-Coulin
- * @copyright OPEN CASCADE 2012
+ * @copyright OPEN CASCADE 2012-2014
*/
import java.io.File;
import java.util.List;
import java.util.ResourceBundle;
-import org.apache.log4j.Logger;
import org.splat.dal.bo.kernel.User;
import org.splat.dal.bo.som.Document;
import org.splat.dal.bo.som.DocumentType;
import org.splat.dal.bo.som.Scenario;
import org.splat.dal.bo.som.SimulationContext;
import org.splat.dal.bo.som.Study;
+import org.splat.dal.bo.som.UsesRelation;
import org.splat.kernel.Do;
+import org.splat.log.AppLogger;
import org.splat.manox.Toolbox;
import org.splat.manox.Writer;
import org.splat.service.DocumentService;
import org.splat.som.StepRights;
import org.splat.som.StudyRights;
import org.splat.util.BeanHelper;
+import org.splat.wapp.Constants;
import org.splat.wapp.ToolBar;
-public class OpenStudy extends OpenObject implements OpenStudyServices {
+/**
+ * Presentation of the currently open study.
+ */
+public class OpenStudy extends AbstractOpenObject implements OpenStudyServices {
/**
* Serial version ID.
*/
- protected final static Logger LOGGER = org.splat.simer.Action.LOG;
+ protected final static AppLogger LOGGER = org.splat.simer.Action.LOG;
+ /**
+ * The currently open study.
+ */
private transient Study _mystudy;
- private transient StudyRights _urightstudy; // User rights on the open study
- private transient StepRights _urightstep; // User rights on the selected step
+ /**
+ * User rights on the open study.
+ */
+ private transient StudyRights _urightstudy;
+ /**
+ * User rights on the selected step.
+ */
+ private transient StepRights _urightstep;
+ /**
+ * The study version.
+ */
private transient String _version;
+ /**
+ * The study creation date.
+ */
private transient String _credate;
+ /**
+ * The study modification date.
+ */
private transient String _lasdate;
+ /**
+ * The selected document publication.
+ */
private transient Publication _selecdoc;
/**
* Injected step service.
*/
private StudyService _studyService;
- // ==============================================================================================================================
+ // =========================================================================
// Constructor
- // ==============================================================================================================================
+ // =========================================================================
/**
* Open the given study in the current http session.
ResourceBundle custom = ResourceBundle.getBundle("som",
getApplicationSettings().getCurrentLocale());
SimpleDateFormat datstring = new SimpleDateFormat(custom
- .getString("date.format"));
+ .getString("date.format"), getApplicationSettings()
+ .getCurrentLocale());
Revision.Format verstring = new Revision.Format(getProjectSettings()
.getRevisionPattern());
- cuser = user; // May be null if nobody connected
+ _cuser = user; // May be null if nobody connected
+ if(!study.equals(_mystudy)) {
+ _selection = "0.1"; // Default selection
+ }
_mystudy = study;
- selection = "0.1"; // Default selection
_selecdoc = null;
// Preparation of the display
_version = verstring.format(_mystudy.getVersion());
_credate = datstring.format(_mystudy.getDate());
- _lasdate = ""; // Not yet supported
- description = _mystudy.getDescription();
- involving = new ArrayList<Step>(1);
- context = new ArrayList<SimulationContextFacade>();
- ustep = getProjectElementService().getFirstStep(_mystudy);
- ustep.setActor(cuser);
- involving.add(ustep);
- for (Iterator<SimulationContext> i = ustep.getAllSimulationContexts()
+ _lasdate = datstring.format(_mystudy.getLastModificationDate());
+ _description = _mystudy.getDescription();
+ //_involving = new ArrayList<Step>(1);
+ _context = new ArrayList<SimulationContextFacade>();
+ if (_selection.equals("0.1")) {
+ _ustep = getProjectElementService().getFirstStep(_mystudy);
+ }
+ _ustep.setActor(_cuser);
+ if ((_involving.isEmpty()) || (_involving.get(0).getOwnerStudy().getIndex()
+ != _ustep.getOwnerStudy().getIndex())) {
+ _involving.clear();
+ _involving.add(_ustep);
+ }
+ for (Iterator<SimulationContext> i = _ustep.getAllSimulationContexts()
.iterator(); i.hasNext();) {
- context.add(new SimulationContextFacade(i.next(),
- getProjectSettings().getAllSteps()));
+ _context.add(new SimulationContextFacade(i.next(),
+ getProjectSettings().getAllSteps(),
+ getApplicationSettings()));
}
- if (getStudyService().isStaffedBy(_mystudy, cuser)
- || getStudyService().hasActor(_mystudy, cuser)) {
+ if (getStudyService().isStaffedBy(_mystudy, _cuser)
+ || getStudyService().hasActor(_mystudy, _cuser)) {
// ProgressState state = mystudy.getProgressState();
// if (state == ProgressState.inCHECK) popup = getApplicationSettings().getPopupMenu("stapprovable");
// else if (state == ProgressState.APPROVED) popup = getApplicationSettings().getPopupMenu("stapproved");
- /* else */popup = getApplicationSettings().getPopupMenu(
- "steditable");
- popup.setContext("study", new StudyRights(cuser, _mystudy));
+ /* else */
+
+ if (_mystudy.getProgressState() == ProgressState.TEMPLATE) {
+ if (_mystudy.isPublic()) {
+ _popup = getApplicationSettings().getPopupMenu(
+ "steditableunmarkprivate");
+ } else {
+ _popup = getApplicationSettings().getPopupMenu(
+ "steditableunmarkpublic");
+ }
+ } else {
+
+ if (_mystudy.isPublic()) {
+ _popup = getApplicationSettings().getPopupMenu(
+ "steditablemarkprivate");
+ } else {
+ String key = null;
+ switch(_mystudy.getProgressState()) {
+ case inWORK:
+ key = "steditable";
+ break;
+ case inDRAFT:
+ key = "streviewable";
+ break;
+ case inCHECK:
+ key = "stapprovable";
+ break;
+ default: // APPROVED
+ key = "steditablemarkpublic";
+ break;
+ }
+ if(Long.valueOf(getSelectedScenarioId()) != 0) {
+ key += "ScenarioSelected";
+ }
+ _popup = getApplicationSettings().getPopupMenu(key);
+ }
+
+ }
+ _popup.setContext(Constants.STUDY_MENU, new StudyRights(_cuser,
+ _mystudy));
}
- _urightstudy = new StudyRights(cuser, _mystudy);
- _urightstep = new StepRights(cuser, ustep);
+ _urightstudy = new StudyRights(_cuser, _mystudy);
+ _urightstep = new StepRights(_cuser, _ustep);
// RKV menu = new StudyMenu(mystudy);
- menu = (getMenu()).init(_mystudy); // RKV
- menu.selects(selection); // Initializes menu items to be displayed
+ _menu = (getMenu()).init(_mystudy); // RKV
+ _menu.selects(_selection); // Initializes menu items to be displayed
setupContents(); // Initializes documents and knowledge at ustep
return this;
}
- // ==============================================================================================================================
+ // =========================================================================
// Getters
- // ==============================================================================================================================
+ // =========================================================================
+ /**
+ * {@inheritDoc}
+ *
+ * @see org.splat.service.dto.Proxy#getAuthorName()
+ */
+ @Override
public String getAuthorName() {
return _mystudy.getAuthor().toString();
}
+ /**
+ * {@inheritDoc}
+ *
+ * @see org.splat.service.dto.Proxy#getIndex()
+ */
+ @Override
public Long getIndex() {
return _mystudy.getIndex();
}
+ /**
+ * Get creation date.
+ *
+ * @return the date
+ */
public String getDate() {
return _credate;
}
+ /**
+ * {@inheritDoc}
+ *
+ * @see org.splat.simer.AbstractOpenObject#getMenu()
+ */
@Override
public StudyMenu getMenu() {
- return (StudyMenu) menu;
+ return (StudyMenu) _menu;
}
+ /**
+ * Set study menu.
+ *
+ * @param aMenu
+ * the study menu
+ */
public void setMenu(final StudyMenu aMenu) {
- menu = aMenu;
+ _menu = aMenu;
}
+ /**
+ * {@inheritDoc}
+ *
+ * @see org.splat.service.dto.Proxy#getProgressState()
+ */
+ @Override
public ProgressState getProgressState() {
return _mystudy.getProgressState();
}
+ /**
+ * Get last modification date.
+ *
+ * @return the date
+ */
public String getLastModificationDate() {
return _lasdate;
}
+ /**
+ * Get the toolbar with buttons of available modules.
+ *
+ * @return the toolbar
+ */
public ToolBar getModuleBar() {
return getApplicationSettings().getModuleBar(getSelectedStep());
}
+ /**
+ * {@inheritDoc}
+ *
+ * @see org.splat.service.dto.Proxy#getReference()
+ */
+ @Override
public String getReference() {
return _mystudy.getReference();
}
+ /**
+ * {@inheritDoc}
+ *
+ * @see org.splat.simer.OpenStudyServices#getSelectedDocument()
+ */
+ @Override
public Publication getSelectedDocument() {
return _selecdoc;
}
+ /**
+ * Get user rights for the selected step.
+ *
+ * @return user step rights
+ */
public StepRights getSelectedStepRights() {
return _urightstep;
}
+ /**
+ * Get user rights for the study.
+ *
+ * @return user study rights
+ */
public StudyRights getStudyRights() {
return _urightstudy;
}
+ /**
+ * Get the detached study object.
+ *
+ * @return the detached study object
+ */
public Study getStudyObject() {
return _mystudy;
}
+ /**
+ * {@inheritDoc}
+ *
+ * @see org.splat.service.dto.Proxy#getTitle()
+ */
+ @Override
public String getTitle() {
return _mystudy.getTitle();
}
+ /**
+ * {@inheritDoc}
+ *
+ * @see org.splat.service.dto.Proxy#getType()
+ */
+ @Override
public String getType() {
- return ResourceBundle.getBundle("labels",
- getApplicationSettings().getCurrentLocale()).getString(
- "label.study");
+ return Constants.STUDY_MENU;
+ }
+
+ /**
+ * {@inheritDoc}
+ * @see org.splat.simer.AbstractOpenObject#getTypeName()
+ */
+ @Override
+ public String getTypeName() {
+ return ResourceBundle.getBundle("labels", getApplicationSettings().getCurrentLocale()).getString( "label.study");
}
+ /**
+ * Get the study version.
+ *
+ * @return the version string
+ */
public String getVersion() {
return _version;
}
+ /**
+ * Check if the selected step is enabled for writing.
+ *
+ * @return true if the selected step is enabled for writing
+ */
public boolean isStepEnabled() {
return _urightstep.isEnabled();
}
- // ==============================================================================================================================
+ // =========================================================================
// Public services
- // ==============================================================================================================================
+ // =========================================================================
+ @Override
public URL newTemplateBasedDocument(final String typename, final User author) {
String filename = typename + ".xml"; // Only XML templates are writeable
File template = new File(getRepositoryService().getTemplatePath()
ResourceBundle locale = ResourceBundle.getBundle("som",
getApplicationSettings().getCurrentLocale());
SimpleDateFormat get = new SimpleDateFormat(locale
- .getString("date.format"));
+ .getString("date.format"), getApplicationSettings()
+ .getCurrentLocale());
Writer tool = Toolbox.getWriter(credoc);
List<Step> slist = getInvolvedSteps();
for (Iterator<Step> i = slist.iterator(); i.hasNext();) {
}
}
tool.updateProperty("reference", medoc.getReference());
- tool.updateProperty("study", _mystudy.getTitle());
+ tool.updateProperty(Constants.STUDY_MENU, _mystudy.getTitle());
tool.updateProperty("step", locale.getString(
"folder.step." + step.getNumber()).replaceAll("''", "'"));
tool.updateProperty("author", author.getUsername().toUpperCase());
String path = docurl.substring(prefix.length());
Document value = getDocumentService().getDocumentByPath(path);
- _selecdoc = ustep.getDocument(value.getIndex());
+ _selecdoc = _ustep.getDocument(value.getIndex());
} catch (Exception error) {
LOGGER.error("Reason:", error);
}
}
}
+ /**
+ * Select an activity (step).
+ *
+ * @param step
+ * the key of the step to select
+ */
public void setSelection(final String step) {
- if (!step.equals(selection)) {
- selection = step;
+ if (!step.equals(_selection)) {
+ _selection = step;
_selecdoc = null;
setupPreviousToSelectedSteps();
updateSimulationContexts(); // Initializes contexts according to the selected steps
}
- ustep = involving.get(involving.size() - 1);
- _urightstep = new StepRights(cuser, ustep);
- ustep.setActor(cuser);
- menu.selects(selection); // Updates menu items to be displayed
+ _ustep = _involving.get(_involving.size() - 1);
+ _urightstep = new StepRights(_cuser, _ustep);
+ _ustep.setActor(_cuser);
+ _menu.selects(_selection); // Updates menu items to be displayed
setupContents(); // The contents may have changed even if the selection is the same
}
- // ==============================================================================================================================
+ // =========================================================================
// Protected services
- // ==============================================================================================================================
+ // =========================================================================
+ /**
+ * Add a new document presentation facade.
+ *
+ * @param doc
+ * the document publication
+ */
protected void add(final Publication doc) {
DocumentFacade facade = new DocumentFacade(this, doc,
- getProjectSettings(), getPublicationService());
- boolean first = (contents.size() == 0);
+ getProjectSettings(), getPublicationService(),
+ getApplicationSettings());
+ boolean first = (_contents.size() == 0);
- docpres.put(doc.getIndex(), facade);
- contents.add(0, facade); // Prepend the new publication
+ _docpres.put(doc.getIndex(), facade);
+ _contents.add(0, facade); // Prepend the new publication
if (first) {
this.getMenu().refreshSelectedItem();
}
-
+ // Refresh dependencies. They can not be removed until removing this document.
+ for (Publication pub : doc.getRelations(UsesRelation.class)) {
+ update(pub);
+ }
}
+ /**
+ * Add a simulation context presentation facade.
+ *
+ * @param contex
+ * the simulation context to add
+ */
protected void add(final SimulationContext contex) {
SimulationContextFacade facade = new SimulationContextFacade(contex,
- getProjectSettings().getAllSteps());
+ getProjectSettings().getAllSteps(), getApplicationSettings());
- context.add(facade);
+ _context.add(facade);
}
+ /**
+ * Add a knowledge element presentation facade.
+ *
+ * @param kelm
+ * the knowledge element to add
+ */
protected void add(final KnowledgeElement kelm) {
KnowledgeElementFacade facade = new KnowledgeElementFacade(BeanHelper
- .copyBean(kelm, KnowledgeElementDTO.class));
+ .copyBean(kelm, KnowledgeElementDTO.class),
+ getApplicationSettings());
// RKV KnowledgeIterator known = knowledge.get(kelm.getType().getIndex() - 2);
// Knowledges are ordered by type index, from 0 to n-1, the first one being reserved (reason for -2)
// RKV:Begin: Find a knowledge iterator for appropriate knowledge type
KnowledgeIterator known = null;
- for (KnowledgeIterator aKnowledgeSection : knowledge) {
+ for (KnowledgeIterator aKnowledgeSection : _knowledge) {
if (aKnowledgeSection.getIndex().equals(
String.valueOf(kelm.getType().getIndex()))) {
known = aKnowledgeSection;
}
}
if (known != null) { // RKV:End
- knowpres.put(kelm.getIndex(), facade);
- known.list.add(facade); // Insert the new knowledge at the end of the corresponding knowledge type
+ _knowpres.put(kelm.getIndex(), facade);
+ known._list.add(facade); // Insert the new knowledge at the end of the corresponding knowledge type
}
}
+ /**
+ * Remove the document presentation facade.
+ *
+ * @param doctag
+ * the document publication to remove
+ */
protected void remove(final Publication doctag) {
- for (Iterator<DocumentFacade> i = contents.iterator(); i.hasNext();) {
+ for (Iterator<DocumentFacade> i = _contents.iterator(); i.hasNext();) {
DocumentFacade facade = i.next();
- if (!facade.isFacadeOf(doctag)) {
- continue;
+ if (facade.isFacadeOf(doctag)) {
+ i.remove();
+ break;
}
- i.remove();
- break;
}
- if (contents.size() == 0) {
+ if (_contents.size() == 0) {
this.getMenu().refreshSelectedItem();
}
}
+ /**
+ * Change the currently connected user and refresh user's rights.
+ *
+ * @param user
+ * the new connected user
+ */
protected void changeUser(final User user) {
- cuser = user;
- popup = null;
- if (getStudyService().isStaffedBy(_mystudy, cuser)) {
- popup = getApplicationSettings().getPopupMenu("steditable");
- popup.setContext("study", new StudyRights(cuser, _mystudy));
+ _cuser = user;
+ _popup = null;
+ if (getStudyService().isStaffedBy(_mystudy, _cuser)) {
+ _popup = getApplicationSettings().getPopupMenu(
+ "steditablemarkpublic");
+ _popup.setContext(Constants.STUDY_MENU, new StudyRights(_cuser,
+ _mystudy));
}
// ustep = getProjectElementService().getFirstStep(mystudy);
- if (ustep != null) {
- ustep.setActor(cuser);
+ if (_ustep != null) {
+ _ustep.setActor(_cuser);
}
- _urightstudy = new StudyRights(cuser, _mystudy);
- _urightstep = new StepRights(cuser, ustep);
+ _urightstudy = new StudyRights(_cuser, _mystudy);
+ _urightstep = new StepRights(_cuser, _ustep);
}
+ /**
+ * Remove the simulation context presentation facade.
+ *
+ * @param contex
+ * the simulation context to remove
+ */
protected void remove(final SimulationContext contex) {
- for (Iterator<SimulationContextFacade> i = context.iterator(); i
+ for (Iterator<SimulationContextFacade> i = _context.iterator(); i
.hasNext();) {
SimulationContextFacade facade = i.next();
- if (!facade.isFacadeOf(contex)) {
- continue;
+ if (facade.isFacadeOf(contex)) {
+ i.remove();
+ break;
}
- i.remove();
- break;
}
}
+ /**
+ * Remove the knowledge element presentation facade.
+ *
+ * @param kelm
+ * the knowledge element to remove
+ */
protected void remove(final KnowledgeElement kelm) {
- KnowledgeIterator known = knowledge.get((int) (kelm.getType()
- .getIndex() - 2));
+ // RKV: KnowledgeIterator known = _knowledge.get((int) (kelm.getType()
+ // RKV: .getIndex() - 2));
// Knowledges are ordered by type index, from 0 to n-1, the first one being reserved (reason for -2)
- knowpres.remove(kelm.getIndex());
- for (Iterator<KnowledgeElementFacade> i = known.list.iterator(); i
- .hasNext();) {
- KnowledgeElementFacade facade = i.next();
- if (!facade.isFacadeOf(BeanHelper.copyBean(kelm,
- KnowledgeElementDTO.class))) {
- continue;
+ // RKV:Begin: Find a knowledge iterator for appropriate knowledge type
+ KnowledgeIterator known = null;
+ for (KnowledgeIterator aKnowledgeSection : _knowledge) {
+ if (aKnowledgeSection.getIndex().equals(
+ String.valueOf(kelm.getType().getIndex()))) {
+ known = aKnowledgeSection;
+ break;
+ }
+ }
+ if (known != null) { // RKV:End
+ _knowpres.remove(kelm.getIndex());
+ for (Iterator<KnowledgeElementFacade> i = known._list.iterator(); i
+ .hasNext();) {
+ KnowledgeElementFacade facade = i.next();
+ if (!facade.isFacadeOf(BeanHelper.copyBean(kelm,
+ KnowledgeElementDTO.class))) {
+ continue;
+ }
+ i.remove();
+ break;
}
- i.remove();
- break;
}
}
+ /**
+ * Refresh the document presentation facade.
+ *
+ * @param doc
+ * the document publication
+ */
protected void update(final Publication doc) {
- DocumentFacade facade = docpres.get(doc.getIndex());
+ DocumentFacade facade = _docpres.get(doc.getIndex());
if (facade != null) {
- facade.refresh();
+ _contents.remove(facade);
+ facade = new DocumentFacade(this, doc,
+ getProjectSettings(), getPublicationService(),
+ getApplicationSettings());
+ _docpres.put(doc.getIndex(), facade);
+ _contents.add(facade);
}
}
+ /**
+ * Refresh the knowledge element presentation facade.
+ *
+ * @param kelm
+ * the knowledge element DTO
+ */
protected void update(final KnowledgeElementDTO kelm) {
- KnowledgeElementFacade facade = knowpres.get(kelm.getIndex());
+ KnowledgeElementFacade facade = _knowpres.get(kelm.getIndex());
if (facade != null) {
facade.refresh(kelm);
}
}
+ /**
+ * Refresh simulation contexts presentation facades.
+ */
protected void updateSimulationContexts() {
- context.clear();
- for (Iterator<Step> i = involving.iterator(); i.hasNext();) {
+ _context.clear();
+ for (Iterator<Step> i = _involving.iterator(); i.hasNext();) {
for (Iterator<SimulationContext> j = i.next()
.getAllSimulationContexts().iterator(); j.hasNext();) {
- context.add(new SimulationContextFacade(j.next(),
- getProjectSettings().getAllSteps()));
+ _context.add(new SimulationContextFacade(j.next(),
+ getProjectSettings().getAllSteps(),
+ getApplicationSettings()));
}
}
}
- // ==============================================================================================================================
+ // =========================================================================
// Private services
- // ==============================================================================================================================
+ // =========================================================================
private void setupPreviousToSelectedSteps() {
- String[] item = selection.split("\\x2E");
+ String[] item = _selection.split("\\x2E");
int major = Integer.valueOf(item[0]);
int minor = Integer.valueOf(item[1]);
int base = minor;
Step[] step;
- involving.clear();
+ _involving.clear();
if (major > 0) {
Scenario[] branch = _mystudy.getScenarii();
Scenario scenar = branch[0];
step = getProjectElementService().getSteps(scenar);
base = step[0].getNumber() - 1;
for (int i = 0; i + base < minor; i++) {
- involving.add(step[i]);
+ _involving.add(step[i]);
}
}
step = getProjectElementService().getSteps(_mystudy);
for (int i = step.length - 1; i > -1; i--) {
Step firstep = step[i];
- if (firstep.getNumber() > base) {
- continue;
+ if (firstep.getNumber() <= base) {
+ _involving.add(0, firstep);
}
- involving.add(0, firstep);
}
}
_documentService = documentService;
}
+ /**
+ * Get the detached study object.
+ *
+ * @return the detached study object
+ */
public Study getMystudy() {
return _mystudy;
}
+ /**
+ * Set the study to present.
+ *
+ * @param mystudy
+ * the selected study detached object
+ */
public void setMystudy(final Study mystudy) {
this._mystudy = mystudy;
}
+
+ /**
+ * Update the current step.
+ *
+ */
+ public final void updateCurrentStep() {
+ setupPreviousToSelectedSteps();
+ _ustep = _involving.get(_involving.size() - 1);
+ }
}
\ No newline at end of file
