public class

Destination

extends ExtensionPoint
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.analytics.Destination

Class Overview

Destination-URL goal.

Summary

Nested Classes
class Destination.MatchType The match type for the path expression. 
Constants
String CASESENSITIVE XML "caseSensitive" attribute name
String EXPRESSION XML "expression" attribute name
String MATCHTYPE XML "matchType" attribute name
String STEP1REQUIRED XML "step1Required" attribute name
String XML_NAME XML element name
Fields
private Boolean caseSensitive Whether path URL matching is case sensitive
private String expression Goal's path expression
private String matchType The match type for the path expression
private Boolean step1Required Whether step 1 is required for this goal
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
Destination()
Default mutable constructor.
Destination(Boolean caseSensitive, String expression, String matchType, Boolean step1Required)
Immutable constructor.
Public Methods
void addStep(Step step)
Adds a new step.
void declareExtensions(ExtensionProfile extProfile)
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
Boolean getCaseSensitive()
Returns the whether path URL matching is case sensitive.
static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
Returns the extension description, specifying whether it is required, and whether it is repeatable.
String getExpression()
Returns the goal's path expression.
String getMatchType()
Returns the the match type for the path expression.
Boolean getStep1Required()
Returns the whether step 1 is required for this goal.
List<Step> getSteps()
Returns the steps.
boolean hasCaseSensitive()
Returns whether it has the whether path URL matching is case sensitive.
boolean hasExpression()
Returns whether it has the goal's path expression.
boolean hasMatchType()
Returns whether it has the the match type for the path expression.
boolean hasStep1Required()
Returns whether it has the whether step 1 is required for this goal.
boolean hasSteps()
Returns whether it has the steps.
void setCaseSensitive(Boolean caseSensitive)
Sets the whether path URL matching is case sensitive.
void setExpression(String expression)
Sets the goal's path expression.
void setMatchType(String matchType)
Sets the the match type for the path expression.
void setStep1Required(Boolean step1Required)
Sets the whether step 1 is required for this goal.
String toString()
Protected Methods
void consumeAttributes(AttributeHelper helper)
Consumes attributes from the attribute helper.
void putAttributes(AttributeGenerator generator)
Puts attributes into the attribute generator.
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension

Constants

private static final String CASESENSITIVE

XML "caseSensitive" attribute name

Constant Value: "caseSensitive"

private static final String EXPRESSION

XML "expression" attribute name

Constant Value: "expression"

private static final String MATCHTYPE

XML "matchType" attribute name

Constant Value: "matchType"

private static final String STEP1REQUIRED

XML "step1Required" attribute name

Constant Value: "step1Required"

static final String XML_NAME

XML element name

Constant Value: "destination"

Fields

private Boolean caseSensitive

Whether path URL matching is case sensitive

private String expression

Goal's path expression

private String matchType

The match type for the path expression

private Boolean step1Required

Whether step 1 is required for this goal

Public Constructors

public Destination ()

Default mutable constructor.

public Destination (Boolean caseSensitive, String expression, String matchType, Boolean step1Required)

Immutable constructor.

Parameters
caseSensitive Whether path URL matching is case sensitive.
expression Goal's path expression.
matchType The match type for the path expression.
step1Required Whether step 1 is required for this goal.

Public Methods

public void addStep (Step step)

Adds a new step.

Parameters
step Step

public void declareExtensions (ExtensionProfile extProfile)

Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The base implementation does not declare any extensions, but can be overridden by specific types of ExtensionPoints that always contain a well-defined set of extensions.

Parameters
extProfile The ExtensionProfile to initialize.

public Boolean getCaseSensitive ()

Returns the whether path URL matching is case sensitive.

Returns
  • whether path URL matching is case sensitive

public static ExtensionDescription getDefaultDescription (boolean required, boolean repeatable)

Returns the extension description, specifying whether it is required, and whether it is repeatable.

Parameters
required Whether it is required
repeatable Whether it is repeatable
Returns
  • extension description

public String getExpression ()

Returns the goal's path expression.

Returns
  • goal's path expression

public String getMatchType ()

Returns the the match type for the path expression.

Returns
  • the match type for the path expression

public Boolean getStep1Required ()

Returns the whether step 1 is required for this goal.

Returns
  • whether step 1 is required for this goal

public List<Step> getSteps ()

Returns the steps.

Returns
  • steps

public boolean hasCaseSensitive ()

Returns whether it has the whether path URL matching is case sensitive.

Returns
  • whether it has the whether path URL matching is case sensitive

public boolean hasExpression ()

Returns whether it has the goal's path expression.

Returns
  • whether it has the goal's path expression

public boolean hasMatchType ()

Returns whether it has the the match type for the path expression.

Returns
  • whether it has the the match type for the path expression

public boolean hasStep1Required ()

Returns whether it has the whether step 1 is required for this goal.

Returns
  • whether it has the whether step 1 is required for this goal

public boolean hasSteps ()

Returns whether it has the steps.

Returns
  • whether it has the steps

public void setCaseSensitive (Boolean caseSensitive)

Sets the whether path URL matching is case sensitive.

Parameters
caseSensitive Whether path URL matching is case sensitive or null to reset

public void setExpression (String expression)

Sets the goal's path expression.

Parameters
expression Goal's path expression or null to reset

public void setMatchType (String matchType)

Sets the the match type for the path expression.

Parameters
matchType The match type for the path expression or null to reset

public void setStep1Required (Boolean step1Required)

Sets the whether step 1 is required for this goal.

Parameters
step1Required Whether step 1 is required for this goal or null to reset

public String toString ()

Protected Methods

protected void consumeAttributes (AttributeHelper helper)

Consumes attributes from the attribute helper. May also use consumeContent(boolean) to consume the element's text content. Called from getHandler(ExtensionProfile, String, String, Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
helper Attribute helper
Throws
ParseException

protected void putAttributes (AttributeGenerator generator)

Puts attributes into the attribute generator. Called from generate(XmlWriter, ExtensionProfile). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
generator Attribute generator

protected void validate ()

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.