/*
* Encog(tm) Core v3.0 - Java Version
* http://www.heatonresearch.com/encog/
* http://code.google.com/p/encog-java/
* Copyright 2008-2011 Heaton Research, Inc.
*
* 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.
*
* For more information on Heaton Research copyrights, licenses
* and trademarks visit:
* http://www.heatonresearch.com/copyright
*/
package org.encog.parse.tags;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.encog.parse.ParseError;
/**
* HTMLTag: This class holds a single HTML tag. This class subclasses the
* AttributeList class. This allows the HTMLTag class to hold a collection of
* attributes, just as an actual HTML tag does.
*/
public class Tag {
/**
* Tag types.
*
* @author jheaton
*/
public enum Type {
/**
* A beginning tag.
*/
BEGIN,
/**
* An ending tag.
*/
END,
/**
* A comment.
*/
COMMENT,
/**
* A CDATA section.
*/
CDATA
};
/**
* The attributes.
*/
private final Map<String, String> attributes =
new HashMap<String, String>();
/**
* The tag name.
*/
private String name = "";
/**
* The tag type.
*/
private Type type;
/**
* Clear the name, type and attributes.
*/
public void clear() {
this.attributes.clear();
this.name = "";
this.type = Type.BEGIN;
}
/**
* @return A cloned copy of the object.
*/
@Override
public Tag clone() {
final Tag result = new Tag();
result.setName(getName());
result.setType(getType());
for (final String key : this.attributes.keySet()) {
final String value = this.attributes.get(key);
result.setAttribute(key, value);
}
return result;
}
/**
* Get the specified attribute as an integer.
*
* @param attributeId
* The attribute name.
* @return The attribute value.
*/
public int getAttributeInt(final String attributeId) {
try {
final String str = getAttributeValue(attributeId);
return Integer.parseInt(str);
} catch (final NumberFormatException e) {
throw new ParseError(e);
}
}
/**
* Get a map of all attributes.
*
* @return The attributes.
*/
public Map<String, String> getAttributes() {
return this.attributes;
}
/**
* Get the value of the specified attribute.
*
* @param name
* The name of an attribute.
* @return The value of the specified attribute.
*/
public String getAttributeValue(final String name) {
return this.attributes.get(name);
}
/**
* @return Get the tag name.
*/
public String getName() {
return this.name;
}
/**
* @return Get the tag type.
*/
public Type getType() {
return this.type;
}
/**
* Set a HTML attribute.
*
* @param name
* The name of the attribute.
* @param value
* The value of the attribute.
*/
public void setAttribute(final String name, final String value) {
this.attributes.put(name, value);
}
/**
* Set the tag name.
*
* @param s
* The name.
*/
public void setName(final String s) {
this.name = s;
}
/**
* Set the tag type.
*
* @param type
* The tag type.
*/
public void setType(final Type type) {
this.type = type;
}
/**
* Convert this tag back into string form, with the beginning < and ending
* >.
*
* @return The Attribute object that was found.
*/
@Override
public String toString() {
final StringBuilder buffer = new StringBuilder("<");
if (this.type == Type.END) {
buffer.append("/");
}
buffer.append(this.name);
final Set<String> set = this.attributes.keySet();
for (final String key : set) {
final String value = this.attributes.get(key);
buffer.append(' ');
if (value == null) {
buffer.append("\"");
buffer.append(key);
buffer.append("\"");
} else {
buffer.append(key);
buffer.append("=\"");
buffer.append(value);
buffer.append("\"");
}
}
buffer.append(">");
return buffer.toString();
}
}