KmlEdit

com.phasmidsoftware.xmldoc.kml.KmlEdit
See theKmlEdit companion class
object KmlEdit

Companion object for KmlEdit, providing methods and constants used for editing KML elements.

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
KmlEdit.type

Members list

Type members

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements.

The names of the product elements.

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type.

The name of the type.

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def apply(command: String, op1: Element, maybeOp2: Option[Element]): KmlEdit

Method to create a KmlEdit from a command, an Element, and an optional Element.

Method to create a KmlEdit from a command, an Element, and an optional Element.

Value parameters

command

the command string.

maybeOp2

(optional) second element.

op1

the first element.

Attributes

Returns

a KmlEdit.

def editFeatures(edit: KmlEdit, fs: Seq[Feature]): Seq[Feature]

Process the given feature set and return a new feature set that is the result of the processing.

Process the given feature set and return a new feature set that is the result of the processing.

Value parameters

edit

the Edit to be applied.

fs

a sequence of Feature, the children of a particular object that extends HasFeatures (i.e. Kml, Document, or Folder).

Attributes

Returns

a (potentially) different sequence of Feature.

def operands(command: String): Int

Determines the number of operands required for a given command.

Determines the number of operands required for a given command.

Value parameters

command

the command string to evaluate.

Attributes

Returns

the number of operands required for the specified command.

def parse(w: String): IO[KmlEdit]

Method to parse a line of text as a KmlEdit.

Method to parse a line of text as a KmlEdit.

Value parameters

w

the String to be parsed.

Attributes

Returns

an IO[KmlEdit].

def parseLines(ws: Iterator[String]): IO[Seq[KmlEdit]]

Method to parse an iterator of lines of text.

Method to parse an iterator of lines of text.

Value parameters

ws

an Iterator[String] typically from Source.getLines.

Attributes

Returns

a Seq[KmlEdit] wrapped in IO.

Concrete fields

val DELETE: String

delete an element.

delete an element.

Attributes

val INVERT: String

invert an element.

invert an element.

Attributes

val JOIN: String

Join two elements (typically using the merge method of Mergeable KML objects).

Join two elements (typically using the merge method of Mergeable KML objects).

Attributes

val JOINX: String

like JOIN but retains the first name (i.e. it excludes the second name).

like JOIN but retains the first name (i.e. it excludes the second name).

Attributes