org.openmdx.portal.servlet.FindObjectsAutocompleter Maven / Gradle / Ivy
The newest version!
/*
* ====================================================================
* Project: openMDX/Portal, http://www.openmdx.org/
* Description: FindObjectsAutocompleter
* Owner: the original authors.
* ====================================================================
*
* This software is published under the BSD license
* as listed below.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of the openMDX team nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* ------------------
*
* This product includes software developed by the Apache Software
* Foundation (http://www.apache.org/).
*
* This product includes yui, the Yahoo! UI Library
* (License - based on BSD).
*
*/
package org.openmdx.portal.servlet;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import org.openmdx.base.exception.ServiceException;
import org.openmdx.base.naming.Path;
import org.openmdx.base.query.ConditionType;
import org.openmdx.kernel.log.SysLog;
import org.openmdx.portal.servlet.action.FindObjectsAction;
import org.openmdx.portal.servlet.attribute.AttributeValue;
import org.openmdx.portal.servlet.attribute.ObjectReferenceValue;
/**
* FindObjectsAutocompleter
*
*/
public class FindObjectsAutocompleter implements Autocompleter_1_0, Serializable {
/**
* Create an input field control with Ajax.Autocompleter based auto completion.
* Multiple triples {filterByFeature, filterOperator, orderByFeature} can be specified.
* This allows to register different auto completion methods for a specific field. The
* completer with index 0 is active by default. A specific completer is selected
* by the user. The completer uses the EVENT_FIND_OBJECTS of ObjectInspectorServlet
* in order to get the objects located at the specified target object and
* reference.
*
* @param target
* @param referenceName
* @param filterByType
* @param filterByFeature
* @param filterByLabel
* @param filterOperator
* @param orderByFeature
*/
public FindObjectsAutocompleter(
Path target,
String[] referenceName,
String filterByType,
String[] filterByFeature,
String[] filterByLabel,
ConditionType[] filterOperator,
String[] orderByFeature
) {
this.target = target;
this.referenceName = referenceName;
this.filterByType = filterByType;
this.filterByFeature = filterByFeature;
this.filterByLabel = filterByLabel;
this.filterOperator = filterOperator;
this.orderByFeature = orderByFeature;
this.findObjectsActions = new Action[filterByFeature.length];
for(
int i = 0;
i < this.filterByFeature.length;
i++
) {
List parameters = new ArrayList();
// xri
parameters.add(
new Action.Parameter(
Action.PARAMETER_OBJECTXRI,
this.target.toXRI()
)
);
// referenceName
parameters.add(
new Action.Parameter(
Action.PARAMETER_REFERENCE_NAME,
this.referenceName[i]
)
);
// filterByType
if(this.filterByType != null) {
parameters.add(
new Action.Parameter(
Action.PARAMETER_FILTER_BY_TYPE,
this.filterByType
)
);
}
// filterByFeature
if(this.filterByFeature[i] != null) {
parameters.add(
new Action.Parameter(
Action.PARAMETER_FILTER_BY_FEATURE,
this.filterByFeature[i]
)
);
}
// filterOperator
parameters.add(
new Action.Parameter(
Action.PARAMETER_FILTER_OPERATOR,
this.filterOperator[i].toString()
)
);
// orderByByFeature
if(this.orderByFeature[i] != null && !this.orderByFeature[i].isEmpty()) {
parameters.add(
new Action.Parameter(
Action.PARAMETER_ORDER_BY_FEATURE,
this.orderByFeature[i]
)
);
}
// position
parameters.add(
new Action.Parameter(
Action.PARAMETER_POSITION,
"0"
)
);
// size
parameters.add(
new Action.Parameter(
Action.PARAMETER_SIZE,
"20"
)
);
this.findObjectsActions[i] = new Action(
FindObjectsAction.EVENT_ID,
parameters.toArray(new Action.Parameter[parameters.size()]),
this.filterByLabel[i],
true
);
}
}
/* (non-Javadoc)
* @see org.openmdx.portal.servlet.Autocompleter_1_0#paint(org.openmdx.portal.servlet.ViewPort, java.lang.String, int, java.lang.String, org.openmdx.portal.servlet.attribute.AttributeValue, boolean, java.lang.CharSequence, java.lang.CharSequence, java.lang.CharSequence, java.lang.CharSequence, java.lang.CharSequence)
*/
@Override
public void paint(
ViewPort p,
String id,
int tabIndex,
String fieldName,
AttributeValue currentValue,
boolean numericCompare,
CharSequence tdTag,
CharSequence inputFieldDivClass,
CharSequence inputFieldClass,
CharSequence imgTag,
CharSequence onChangeValueScript
) throws ServiceException {
SysLog.detail("> paint");
id = (id == null) || (id.length() == 0)
? fieldName + (tabIndex >= 0 ? "[" + tabIndex + "]" : "")
: id;
HtmlEncoder_1_0 htmlEncoder = p.getApplicationContext().getHtmlEncoder();
// Get current value as object reference
ObjectReference objectReference = null;
if(
(currentValue != null) &&
(currentValue instanceof ObjectReferenceValue)
) {
objectReference = (ObjectReference)currentValue.getValue(p, false);
}
// Generate id if none is specified
String acName = "ac_" + fieldName.replace(':', '_').replace('!', '_').replace('*', '_') + Integer.toString(tabIndex);
p.write("");
p.write(" ");
p.write(" - ", p.getImg("border=\"0\" alt=\"\" src=\"", p.getResourcePath("images/"), WebKeys.ICON_AUTOCOMPLETE_SELECT, "\""), "");
p.write("
");
for(int i = 0; i < findObjectsActions.length; i++) {
p.write(" ", htmlEncoder.encode(findObjectsActions[i].getTitle(), false), "
");
}
p.write("
");
p.write(" ");
p.write(" ");
p.write("");
p.write("", (imgTag == null ? "" : " " + imgTag) ,"");
p.write("");
if(tdTag != null) {
p.write("");
p.write(tdTag);
}
p.write("");
p.write("");
}
/* (non-Javadoc)
* @see org.openmdx.portal.servlet.Autocompleter_1_0#hasFixedSelectableValues()
*/
@Override
public boolean hasFixedSelectableValues(
) {
return false;
}
//-----------------------------------------------------------------------
// Members
//-----------------------------------------------------------------------
private static final long serialVersionUID = -1138020420475572050L;
private final Path target;
private final String[] referenceName;
private final String filterByType;
private final String[] filterByFeature;
private final String[] filterByLabel;
private final ConditionType[] filterOperator;
private final String[] orderByFeature;
private final Action[] findObjectsActions;
}