|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.data.AbstractExtension
com.google.gdata.data.ExtensionPoint
com.google.gdata.data.analytics.Segment
public class Segment
Describes a segment.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint |
---|
ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler |
Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension |
---|
AbstractExtension.AttributesHandler |
Field Summary |
---|
Fields inherited from class com.google.gdata.data.ExtensionPoint |
---|
xmlBlob |
Fields inherited from class com.google.gdata.data.AbstractExtension |
---|
localName, namespace |
Constructor Summary | |
---|---|
Segment()
Default mutable constructor. |
|
Segment(java.lang.String id,
java.lang.String name)
Immutable constructor. |
Method Summary | |
---|---|
void |
addProperty(Property property)
Adds a new property. |
protected void |
consumeAttributes(AttributeHelper helper)
Consumes attributes from the attribute helper. |
void |
declareExtensions(ExtensionProfile extProfile)
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. |
static ExtensionDescription |
getDefaultDescription(boolean required,
boolean repeatable)
Returns the extension description, specifying whether it is required, and whether it is repeatable. |
Definition |
getDefinition()
Returns the definition. |
java.lang.String |
getId()
Returns the id of the segment. |
java.lang.String |
getName()
Returns the name of the segment. |
java.util.List<Property> |
getProperties()
Returns the properties. |
java.lang.String |
getProperty(java.lang.String name)
Returns the value of the named property of this entry. |
boolean |
hasDefinition()
Returns whether it has the definition. |
boolean |
hasId()
Returns whether it has the id of the segment. |
boolean |
hasName()
Returns whether it has the name of the segment. |
boolean |
hasProperties()
Returns whether it has the properties. |
protected void |
putAttributes(AttributeGenerator generator)
Puts attributes into the attribute generator. |
void |
setDefinition(Definition definition)
Sets the definition. |
void |
setId(java.lang.String id)
Sets the id of the segment. |
void |
setName(java.lang.String name)
Sets the name of the segment. |
java.lang.String |
toString()
|
protected void |
validate()
Checks the attributes to see if there are any problems. |
Methods inherited from class com.google.gdata.data.AbstractExtension |
---|
disableStrictValidation, enableStrictValidation, eq, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Segment()
public Segment(java.lang.String id, java.lang.String name)
id
- id of the segment.name
- name of the segment.Method Detail |
---|
public void declareExtensions(ExtensionProfile extProfile)
ExtensionPoint
declareExtensions
in class ExtensionPoint
extProfile
- the ExtensionProfile to initialize.public Definition getDefinition()
public void setDefinition(Definition definition)
definition
- definition or null
to resetpublic boolean hasDefinition()
public java.lang.String getId()
public void setId(java.lang.String id)
id
- id of the segment or null
to resetpublic boolean hasId()
public java.lang.String getName()
public void setName(java.lang.String name)
name
- name of the segment or null
to resetpublic boolean hasName()
public java.util.List<Property> getProperties()
public void addProperty(Property property)
property
- propertypublic boolean hasProperties()
protected void validate()
AbstractExtension
validate
in class AbstractExtension
public static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
required
- whether it is requiredrepeatable
- whether it is repeatable
protected void putAttributes(AttributeGenerator generator)
AbstractExtension
AbstractExtension.generate(XmlWriter,ExtensionProfile)
. Default implementation
does nothing, though generally this is discouraged unless there really are
no attributes.
putAttributes
in class AbstractExtension
generator
- attribute generatorprotected void consumeAttributes(AttributeHelper helper) throws ParseException
AbstractExtension
AttributeHelper.consumeContent(boolean)
to consume the element's text
content. Called from AbstractExtension.getHandler(com.google.gdata.data.ExtensionProfile, java.lang.String, java.lang.String, org.xml.sax.Attributes)
. Default implementation does
nothing, though generally this is discouraged unless there really are no
attributes.
consumeAttributes
in class AbstractExtension
helper
- attribute helper
ParseException
- any parsing exceptionpublic java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getProperty(java.lang.String name)
value
attribute of the
dxp:property
whose name
attribute matches the argument.
Returns null
if no such property exists.
name
- the property to retrieve from this entry
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |