/*****************************************************************************************
* COPYRIGHT (c), 2007, RAYTHEON COMPANY
* ALL RIGHTS RESERVED, An Unpublished Work
*
* RAYTHEON PROPRIETARY
* If the end user is not the U.S. Government or any agency thereof, use
* or disclosure of data contained in this source code file is subject to
* the proprietary restrictions set forth in the Master Rights File.
*
* U.S. GOVERNMENT PURPOSE RIGHTS NOTICE
* If the end user is the U.S. Government or any agency thereof, this source
* code is provided to the U.S. Government with Government Purpose Rights.
* Use or disclosure of data contained in this source code file is subject to
* the "Government Purpose Rights" restriction in the Master Rights File.
*
* U.S. EXPORT CONTROLLED TECHNICAL DATA
* Use or disclosure of data contained in this source code file is subject to
* the export restrictions set forth in the Master Rights File.
******************************************************************************************/
package com.raytheon.viz.volumebrowser;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
import com.raytheon.uf.common.dataquery.requests.RequestConstraint;
import com.raytheon.uf.viz.core.drawables.AbstractRenderableDisplay;
import com.raytheon.uf.viz.core.drawables.IDescriptor;
import com.raytheon.uf.viz.core.drawables.ResourcePair;
import com.raytheon.uf.viz.core.procedures.Bundle;
import com.raytheon.uf.viz.core.rsc.AbstractRequestableResourceData;
import com.raytheon.uf.viz.core.rsc.AbstractResourceData;
import com.raytheon.uf.viz.core.rsc.IResourceGroup;
import com.raytheon.uf.viz.core.rsc.ResourceList;
import com.raytheon.uf.viz.d2d.core.procedures.AlterBundleChangeEvent;
import com.raytheon.uf.viz.d2d.core.procedures.AlterBundleContributorAdapter;
import com.raytheon.uf.viz.d2d.core.procedures.IAlterBundleContributor;
import com.raytheon.uf.viz.d2d.core.procedures.IBaseLinesContainer;
import com.raytheon.uf.viz.d2d.core.procedures.IPointsToolContainer;
import com.raytheon.uf.viz.d2d.ui.dialogs.procedures.ProcedureDlg;
import com.raytheon.uf.viz.points.IPointChangedListener;
import com.raytheon.uf.viz.points.PointUtilities;
import com.raytheon.uf.viz.points.PointsDataManager;
import com.raytheon.uf.viz.points.data.IPointNode;
import com.raytheon.uf.viz.xy.crosssection.rsc.CrossSectionResourceData;
import com.raytheon.viz.awipstools.ToolsDataManager;
import com.raytheon.viz.volumebrowser.datacatalog.AbstractDataCatalog;
import com.raytheon.viz.volumebrowser.datacatalog.DataCatalogManager;
import com.raytheon.viz.volumebrowser.vbui.SelectedData;
import org.locationtech.jts.geom.Coordinate;
import org.locationtech.jts.geom.LineString;
/**
* This class generates the alter bundle's contributions for points and lines.
*
*
*
* SOFTWARE HISTORY
*
* Date Ticket# Engineer Description
* ------------- -------- -------------- --------------------------------------
* Aug 08, 2012 875 rferrel Generate menu entries for points.
* Oct 03, 2012 1248 rferrel Added listener for when points change.
* May 03, 2013 14824 mgamazaychikov Added alterResource method
* Dec 11, 2013 2602 bsteffen Fix compiler warnings and format.
* Aug 25, 2015 4785 njensen Fix point alters of sources without reportType
* Apr 06, 2018 6718 bsteffen Add last edit.
*
*
*
* @author mschenke
*/
public class ToolsAlterBundleContributor extends AlterBundleContributorAdapter {
private static final String POINTS_PREFIX = "Point-";
private static final String LINES_PREFIX = "Line-";
private static final String POINTS_KEY = "point";
private static final String LINES_KEY = "line";
private static final String LAST_EDIT_PREFIX = "Last Edit ";
private static final String PLUGIN_KEY = "pluginName";
private static final String REPORTYPE_KEY = "reportType";
private IPointChangedListener pointChangedListener;
@Override
public Map getAlterables() {
Map alterables = new HashMap<>();
String[] linesValues = createLineArray();
String[] pointsValues = createPointArray();
alterables.put(LINES_KEY, linesValues);
alterables.put(POINTS_KEY, pointsValues);
return alterables;
}
private static final Pattern pat = Pattern.compile(File.separator + "+");
private List createChildrenList(PointsDataManager pdm,
IPointNode parent) {
List childrenList = new ArrayList<>();
for (IPointNode node : pdm.getChildren(parent)) {
if (node.isGroup()) {
String value = node.getGroup().replace(
PointUtilities.DELIM_CHAR, ' ') + File.separator;
value = pat.matcher(value)
.replaceAll(IAlterBundleContributor.MENU_SEPARATOR);
childrenList.add(value);
childrenList.addAll(createChildrenList(pdm, node));
} else {
String value = (node.getGroup() + File.separator + POINTS_PREFIX
+ node.getName()).replace(PointUtilities.DELIM_CHAR,
' ');
value = pat.matcher(value)
.replaceAll(IAlterBundleContributor.MENU_SEPARATOR);
childrenList.add(value);
}
}
return childrenList;
}
private String[] createLineArray() {
ToolsDataManager tdm = ToolsDataManager.getInstance();
Collection blNames = tdm.getBaselineNames();
List lines = new ArrayList<>(blNames.size() + 3);
for (String line : blNames) {
lines.add(LINES_PREFIX + line);
}
lines.sort(Comparator.naturalOrder());
lines.add(0, ProcedureDlg.ORIGINAL);
lines.add(0, ProcedureDlg.CURRENT);
String lastEdit = tdm.getLastEditedBaselineName();
if (lastEdit != null) {
lines.add(0,
LAST_EDIT_PREFIX + "(" + LINES_PREFIX + lastEdit + ")");
}
return lines.toArray(new String[0]);
}
private String[] createPointArray() {
PointsDataManager pdm = PointsDataManager.getInstance();
List pointsList = new ArrayList<>();
String lastEdit = pdm.getLastEditName();
if (lastEdit != null) {
pointsList.add(
LAST_EDIT_PREFIX + "(" + POINTS_PREFIX + lastEdit + ")");
}
pointsList.add(ProcedureDlg.ORIGINAL);
pointsList.add(ProcedureDlg.CURRENT);
pointsList.add(IAlterBundleContributor.MI_SEPARATOR);
pointsList.addAll(createChildrenList(pdm, null));
String[] pointsValues = pointsList.toArray(new String[0]);
return pointsValues;
}
@Override
public void alterBundle(Bundle bundleToAlter, String alterKey,
String alterValue) {
if (alterValue != null) {
if (POINTS_KEY.equals(alterKey)) {
if (ProcedureDlg.CURRENT.equals(alterValue)) {
for (AbstractRenderableDisplay display : bundleToAlter
.getDisplays()) {
replaceWithCurrentPoints(
display.getDescriptor().getResourceList());
}
} else if (alterValue.startsWith(LAST_EDIT_PREFIX)) {
String pointInParenthesis = alterValue
.replace(LAST_EDIT_PREFIX, "");
String pointWithPrefix = pointInParenthesis.substring(1,
pointInParenthesis.length() - 1);
String point = pointWithPrefix.replace(POINTS_PREFIX, "");
alterPoints(bundleToAlter, point);
} else if (!ProcedureDlg.ORIGINAL.equals(alterValue)) {
String point = alterValue.replace(POINTS_PREFIX, "");
alterPoints(bundleToAlter, point);
}
} else if (LINES_KEY.equals(alterKey)) {
if (ProcedureDlg.CURRENT.equals(alterValue)) {
replaceWithCurrentLines(bundleToAlter);
} else if (alterValue.startsWith(LAST_EDIT_PREFIX)) {
String lineInParenthesis = alterValue
.replace(LAST_EDIT_PREFIX, "");
String lineWithPrefix = lineInParenthesis.substring(1,
lineInParenthesis.length() - 1);
String line = lineWithPrefix.replace(LINES_PREFIX, "");
alterLines(bundleToAlter, line);
} else if (!ProcedureDlg.ORIGINAL.equals(alterValue)) {
String line = alterValue.replace(LINES_PREFIX, "");
alterLines(bundleToAlter, line);
}
}
}
}
private void replaceWithCurrentPoints(ResourceList list) {
for (ResourcePair rp : list) {
AbstractResourceData rData = rp.getResourceData();
if (rData instanceof IPointsToolContainer) {
alterContainer((IPointsToolContainer) rData,
((IPointsToolContainer) rData).getPointLetter());
} else if (rData instanceof IResourceGroup) {
replaceWithCurrentPoints(
((IResourceGroup) rData).getResourceList());
}
}
}
private void replaceWithCurrentLines(Bundle b) {
for (AbstractRenderableDisplay display : b.getDisplays()) {
IDescriptor desc = display.getDescriptor();
if (desc instanceof IBaseLinesContainer) {
String line = ((IBaseLinesContainer) desc).getBaseLine();
if (line != null && line.startsWith("Line")) {
alterContainer((IBaseLinesContainer) desc,
line.replace("Line", ""));
}
}
}
}
private void alterPoints(Bundle bundleToAlter, String point) {
for (AbstractRenderableDisplay display : bundleToAlter.getDisplays()) {
alterResourceList(display.getDescriptor().getResourceList(), point);
}
}
private void alterResourceList(ResourceList list, String selectedString) {
for (ResourcePair rp : list) {
AbstractResourceData rData = rp.getResourceData();
if (rData instanceof AbstractRequestableResourceData) {
alterResource((AbstractRequestableResourceData) rData,
POINTS_KEY, selectedString);
alterContainer((IPointsToolContainer) rData, selectedString);
} else if (rData instanceof IResourceGroup) {
alterResourceList(((IResourceGroup) rData).getResourceList(),
selectedString);
}
}
}
private void alterResource(AbstractRequestableResourceData data,
String selectedKey, String selectedString) {
if (selectedString == null) {
return;
}
HashMap metadataMap = data.getMetadataMap();
HashMap metadataMapOld = new HashMap<>();
// make a copy of original matedata map
metadataMapOld.putAll(metadataMap);
// obtain data catalog
AbstractDataCatalog ac = getDataCatalog(metadataMap);
if (ac == null) {
return;
}
// change the parameters in the original metadata map
ac.alterProductParameters(selectedKey, selectedString, metadataMap);
// in addition to metadata map resource data needs to be modified
// for CrossSectionResourceData
if (data instanceof CrossSectionResourceData) {
String theKeyToChange = null;
Iterator> it = metadataMap
.entrySet().iterator();
while (it.hasNext()) {
Map.Entry pairs = it.next();
String currentKey = pairs.getKey();
String currentValue = metadataMap.get(currentKey)
.getConstraintValue();
if (metadataMapOld.containsKey(currentKey)) {
String oldValue = metadataMapOld.get(currentKey)
.getConstraintValue();
if (!oldValue.equalsIgnoreCase(currentValue)) {
theKeyToChange = currentKey;
}
}
}
String stationID = metadataMap.get(theKeyToChange)
.getConstraintValue();
List stationIDs = Arrays
.asList(stationID.split("\\s*,\\s*"));
((CrossSectionResourceData) data).setStationIDs(stationIDs);
}
}
private AbstractDataCatalog getDataCatalog(
HashMap metadataMap) {
String pluginName = null;
String reportType = null;
if (metadataMap.containsKey(PLUGIN_KEY)) {
pluginName = metadataMap.get(PLUGIN_KEY).getConstraintValue();
} else {
return null;
}
if (metadataMap.containsKey(REPORTYPE_KEY)) {
reportType = metadataMap.get(REPORTYPE_KEY).getConstraintValue();
} else {
// not all sources will have a reportType
reportType = "";
}
String sourcesKey = pluginName + reportType;
SelectedData sd = new SelectedData(null, sourcesKey, null, null, null,
null, null);
return (AbstractDataCatalog) DataCatalogManager.getDataCatalogManager()
.getDataCatalog(sd);
}
private void alterContainer(IPointsToolContainer container,
String selectedString) {
Coordinate point = PointsDataManager.getInstance()
.getCoordinate(selectedString);
container.setPointCoordinate(point);
container.setPointLetter(selectedString);
}
private void alterLines(Bundle bundleToAlter, String line) {
for (AbstractRenderableDisplay display : bundleToAlter.getDisplays()) {
if (display.getDescriptor() instanceof IBaseLinesContainer) {
alterContainer((IBaseLinesContainer) display.getDescriptor(),
line);
ResourceList rl = display.getDescriptor().getResourceList();
for (ResourcePair rp : rl) {
AbstractResourceData rData = rp.getResourceData();
if (rData instanceof AbstractRequestableResourceData) {
alterResource((AbstractRequestableResourceData) rData,
LINES_KEY, line);
}
}
}
}
}
private void alterContainer(IBaseLinesContainer container,
String selectedString) {
LineString line = ToolsDataManager.getInstance()
.getBaseline(selectedString);
container.setBaseLine(selectedString);
container.setBaseLineString(line);
}
@Override
public String[] getAlterables(String key) {
if (POINTS_KEY.equals(key)) {
return createPointArray();
} else if (LINES_KEY.equals(key)) {
return createLineArray();
}
return null;
}
@Override
public void listenerSetup() {
if (pointChangedListener == null) {
pointChangedListener = new IPointChangedListener() {
@Override
public void pointChanged() {
notifyBundleListeners();
}
};
PointsDataManager.getInstance()
.addPointsChangedListener(pointChangedListener);
}
}
@Override
public void listenerShutdown() {
if (pointChangedListener != null) {
PointsDataManager.getInstance()
.removePointsChangedListener(pointChangedListener);
pointChangedListener = null;
}
}
/**
* Received notification of changes to points notify anyone interested in
* the change.
*/
private void notifyBundleListeners() {
AlterBundleChangeEvent event = new AlterBundleChangeEvent(
new String[] { POINTS_KEY });
fireAlterBundleChangeListener(event);
}
}