org.jppf.ui.options.AbstractOptionElement Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jppf-admin Show documentation
Show all versions of jppf-admin Show documentation
JPPF, the open source grid computing solution
/*
* JPPF.
* Copyright (C) 2005-2015 JPPF Team.
* http://www.jppf.org
*
* 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.
*/
package org.jppf.ui.options;
import java.util.*;
import javax.swing.tree.TreePath;
/**
* Default abstract implementation of the OptionElement interface.
* @author Laurent Cohen
*/
public abstract class AbstractOptionElement extends AbstractOptionProperties implements OptionElement
{
/**
* Constant for an empty OptionElement array.
*/
private static OptionElement[] EMPTY_OPTION_ELEMENT_ARRAY = new OptionElement[0];
/**
* The parent panel for this option element.
*/
protected OptionElement parent = null;
/**
* The root of the option tree this option belongs to.
*/
protected OptionElement root = null;
/**
* Constructor provided as a convenience to facilitate the creation of
* option elements through reflexion.
*/
protected AbstractOptionElement()
{
}
/**
* Get the parent panel for this option.
* @return an ElementOption instance.
* @see org.jppf.ui.options.OptionElement#getParent()
*/
@Override
public OptionElement getParent()
{
return parent;
}
/**
* Set the parent panel for this option.
* @param parent an ElementOption instance.
*/
public void setParent(final OptionElement parent)
{
this.parent = parent;
if (parent == null) root = null;
}
/**
* Get the root of the option tree this option belongs to.
* @return a OptionElement instance.
* @see org.jppf.ui.options.OptionElement#getRoot()
*/
@Override
public OptionElement getRoot()
{
OptionElement elt = this;
while (elt.getParent() != null) elt = elt.getParent();
root = elt;
return root;
}
/**
* Get the path of this element in the option tree.
* @return a TreePath whose components are OptionElement instances.
* @see org.jppf.ui.options.OptionElement#getPath()
*/
@Override
public TreePath getPath()
{
List list = new ArrayList<>();
OptionElement elt = this;
while (elt != null)
{
list.add(0, elt);
elt = elt.getParent();
}
return new TreePath(list.toArray(EMPTY_OPTION_ELEMENT_ARRAY));
}
/**
* Get the path of this element in the option tree.
* @return a TreePath whose components are OptionElement instances.
* @see org.jppf.ui.options.OptionElement#getPath()
*/
@Override
public String getStringPath()
{
List list = new ArrayList<>();
OptionElement elt = this;
while (elt != null)
{
list.add(0, elt.getName());
elt = elt.getParent();
}
StringBuilder sb = new StringBuilder("/");
for (String aList : list) sb.append('/').append(aList);
return sb.toString();
}
/**
* Find the element with the specified path in the options tree. The path can be absolute,
* in which case it starts with a "e;/"e, otherwise it is considered relative to the requesting element.
* @param path the path of the element to find.
* @return an OptionElement instance, or null if no element could be found with the specified path.
* @see org.jppf.ui.options.OptionElement#findElement(java.lang.String)
*/
@Override
public OptionElement findElement(final String path)
{
if (path == null) return null;
else if ("".equals(path)) return this;
if (path.startsWith("/")) return getRoot().findElement(path.substring(1));
if (path.startsWith(".."))
{
int idx = path.indexOf('/');
return (idx < 0) ? getParent() : getParent().findElement(path.substring(idx + 1));
}
int idx = path.indexOf('/');
if (idx < 0) return getChildForName(path);
String s = path.substring(0, idx);
OptionElement child = getChildForName(s);
return (child == null) ? null : child.findElement(path.substring(idx + 1));
}
/**
* Find the child element of this option element with the specified name.
* @param childName the name of the child to find.
* @return the child with the specified name, or null if this element is not an option page, or if no child
* was found with the given name.
*/
protected OptionElement getChildForName(final String childName)
{
if (!(this instanceof OptionContainer)) return null;
OptionContainer page = (OptionContainer) this;
for (OptionElement elt: page.getChildren())
{
if (childName.equals(elt.getName())) return elt;
}
return null;
}
/**
* Get a string representation of this element.
* @return a string providing information about this option element.
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
StringBuilder sb = new StringBuilder();
sb.append('[').append((this instanceof OptionContainer) ? "Page" : "Option").append(" : ");
sb.append(getClass().getName()).append("] ");
sb.append("name=").append(name);
sb.append("; label=").append(label);
sb.append("; path=").append(getStringPath());
return sb.toString();
}
/**
* Find all the elements with the specified name in the subtree of which this element is the root.
* @param name the name of the elements to find.
* @return a list of OptionElement instances, or null if no element
* could be found with the specified name. The resulting list can be empty, but never null.
* @see org.jppf.ui.options.OptionElement#findAllWithName(java.lang.String)
*/
@Override
public List findAllWithName(final String name)
{
if (name.startsWith("/")) return getRoot().findAllWithName(name.substring(1));
List list = new ArrayList<>();
findAll(name, list);
return list;
}
/**
* Find the first element with the specified name in the subtree of which this element is the root.
* @param name the name of the element to find.
* @return an OptionElement instance, or null if no element could be found with the specified name.
* @see org.jppf.ui.options.OptionElement#findFirstWithName(java.lang.String)
*/
@Override
public OptionElement findFirstWithName(final String name)
{
List list = findAllWithName(name);
return list.isEmpty() ? null : list.get(0);
}
/**
* Find the last element with the specified name in the subtree of which this element is the root.
* The notion of last element relates to a depth-first search in the tree.
* @param name the name of the element to find.
* @return an OptionElement instance, or null if no element could be found with the specified name.
* @see org.jppf.ui.options.OptionElement#findLastWithName(java.lang.String)
*/
@Override
public OptionElement findLastWithName(final String name)
{
List list = findAllWithName(name);
return list.isEmpty() ? null : list.get(list.size() - 1);
}
/**
* Find all the elements with the specified name in the subtree of which
* this element is the root.
* @param name the name of the elements to find.
* @param list a list of OptionElement instances, to fill with the elements found.
* could be found with the specified name. The resulting list can be empty, but never null.
*/
protected void findAll(final String name, final List list)
{
if (name.equals(getName())) list.add(this);
if (this instanceof OptionContainer)
{
OptionContainer page = (OptionContainer) this;
for (OptionElement elt: page.getChildren()) ((AbstractOptionElement) elt).findAll(name, list);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy