com.atakmap.coremap.cot.event

Class CotDetail

java.lang.Object

com.atakmap.coremap.cot.event.CotDetail

All Implemented Interfaces:

android.os.Parcelable

public class CotDetail
extends java.lang.Object
implements android.os.Parcelable

A Cursor on Target root detail tag or sub tag

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<CotDetail>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
CotDetail() Create a default detail tag
CotDetail(CotDetail d) Copy Constructor.
CotDetail(android.os.Parcel source) Create a detail tag from its Parcel representation
CotDetail(java.lang.String elementName) Create a detail tag with a element name

Method Summary

Modifier and Type	Method and Description
void	addChild(CotDetail detail) Add a sub detail tag.
void	buildXml(java.lang.Appendable b) Build the XML representation of the detail tag
void	buildXml(java.lang.StringBuffer b)
void	buildXml(java.lang.StringBuilder b)
int	childCount() The number of sub tags in this detail tag
void	clearAttributes() Remove all attributes
int	describeContents()
java.lang.String	getAttribute(java.lang.String name) Get an attribute by name
int	getAttributeCount() Get the number of attributes in the tag
CotAttribute[]	getAttributes() Get an array of the immutable attributes of the detail tag.
CotDetail	getChild(int index) Get a child detail tag at a given index or null if the index is invalid at the time of the call.
CotDetail	getChild(java.lang.String name) Get the first child detail with the given name This is a shortcut method for getFirstChildByName(int, String) which is more verbose
java.util.List<CotDetail>	getChildren() Get a list of this CoT's children This is much faster than calling getChild(int) in a loop
java.util.List<CotDetail>	getChildrenByName(java.lang.String name) Get all children details with a matching element name
java.lang.String	getElementName() Get the tag element name
CotDetail	getFirstChildByName(int startIndex, java.lang.String childElementName) Get the first sub tag of a certain name starting at some index or null if the childElement is not found or the startIndex is out of bounds.
java.lang.String	getInnerText() Get the inner text of the tag if any.
java.lang.String	removeAttribute(java.lang.String name) Remove an attribute.
void	removeChild(CotDetail detail) Remove a child.
void	setAttribute(java.lang.String name, java.lang.String value) Set an attribute.
void	setChild(int index, CotDetail detail) Set a sub detail tag
void	setElementName(java.lang.String name) Set the element name of the tag
void	setInnerText(java.lang.String text) Set the inner text of this tag.
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<CotDetail> CREATOR

Constructor Detail

CotDetail

public CotDetail()

Create a default detail tag

CotDetail

public CotDetail(CotDetail d)

Copy Constructor.

CotDetail

public CotDetail(java.lang.String elementName)

Create a detail tag with a element name

Parameters:

elementName - the element name

CotDetail

public CotDetail(android.os.Parcel source)

Create a detail tag from its Parcel representation

Parameters:

source - the parcel to extract out the CoT detail.

Method Detail

getElementName

public java.lang.String getElementName()

Get the tag element name

Returns:

the element name

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Get an attribute by name

Parameters:

name - attribute name

Returns:

the attribute

getInnerText

public java.lang.String getInnerText()

Get the inner text of the tag if any. This does not return XML representation of sub tags. Inner-text and sub-tags are mutually exclusive.

Returns:

the inner text of the tag

getAttributes

public CotAttribute[] getAttributes()

Get an array of the immutable attributes of the detail tag. The order is the same as the add order.

Returns:

get a copy of the current attributes.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

childCount

public int childCount()

The number of sub tags in this detail tag

Returns:

the number of sub tags

getChild

public CotDetail getChild(int index)

Get a child detail tag at a given index or null if the index is invalid at the time of the call.

Parameters:

index -

Returns:

the child at the provided index

getChild

public CotDetail getChild(java.lang.String name)

Get the first child detail with the given name This is a shortcut method for getFirstChildByName(int, String) which is more verbose

Parameters:

name - Detail name

Returns:

CoT detail or null if not found

getChildren

public java.util.List<CotDetail> getChildren()

Get a list of this CoT's children This is much faster than calling getChild(int) in a loop

Returns:

List of child nodes

getChildrenByName

public java.util.List<CotDetail> getChildrenByName(java.lang.String name)

Get all children details with a matching element name

Parameters:

name - Element name

Returns:

List of child nodes

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)

Set an attribute. There is no need to do any special escaping of the value. When an XML string is built, escaping of illegal characters is done automatically.

Parameters:

name - the attribute name

value - the value

removeAttribute

public java.lang.String removeAttribute(java.lang.String name)

Remove an attribute.

Parameters:

name - the attribute name (can be anything)

Returns:

get the value removed if any

clearAttributes

public void clearAttributes()

Remove all attributes

setElementName

public void setElementName(java.lang.String name)

Set the element name of the tag

Parameters:

name -

Throws:

java.lang.IllegalArgumentException - if the attribute name is not a legal XML name

addChild

public void addChild(CotDetail detail)

Add a sub detail tag. Since sub tags and inner text are mutually exclusive, a successful calling will clear any inner text.

Parameters:

detail -

Throws:

java.lang.IllegalArgumentException - if detail is null

setChild

public void setChild(int index,
                     CotDetail detail)

Set a sub detail tag

Parameters:

index -

detail -

Throws:

java.lang.IllegalArgumentException - if detail is null

java.lang.ArrayIndexOutOfBoundsException - if index is out of bounds

removeChild

public void removeChild(CotDetail detail)

Remove a child.

setInnerText

public void setInnerText(java.lang.String text)

Set the inner text of this tag. Since sub tags and inner text are mutually exclusive, calling this removes any sub tags

Parameters:

text -

getFirstChildByName

public CotDetail getFirstChildByName(int startIndex,
                                     java.lang.String childElementName)

Get the first sub tag of a certain name starting at some index or null if the childElement is not found or the startIndex is out of bounds.

Parameters:

startIndex - the start index

childElementName - the element name

Returns:

the first child with the child element name

Throws:

buildXml

public void buildXml(java.lang.StringBuffer b)

buildXml

public void buildXml(java.lang.StringBuilder b)

buildXml

public void buildXml(java.lang.Appendable b)
              throws java.io.IOException

Build the XML representation of the detail tag

Parameters:

b - the appendable to use when generating the xml.

Throws:

java.io.IOException

getAttributeCount

public int getAttributeCount()

Get the number of attributes in the tag

Returns:

the number of attributes in a tag

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable