com.cassinidivision.oce.content
Class C_PageComponent

java.lang.Object
  com.webobjects.eocontrol.EOCustomObject
      com.webobjects.eocontrol.EOGenericRecord
          com.cassinidivision.oce.content.base._C_Content
              com.cassinidivision.oce.content.C_Content
                  com.cassinidivision.oce.content.base._C_ContentContainer
                      com.cassinidivision.oce.content.C_ContentContainer
                          com.cassinidivision.oce.content.base._C_PageComponent
                              com.cassinidivision.oce.content.C_PageComponent

All Implemented Interfaces:

_EOPrivateMemento, EODeferredFaulting, EOEnterpriseObject, EOFaulting, EOKeyValueCoding, EOKeyValueCoding._BestBindingCreation._ForwardingBindingCheck, EOKeyValueCoding._KeyBindingCreation, EOKeyValueCodingAdditions, EORelationshipManipulation, EOValidation, NSKeyValueCoding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._ReflectionKeyBindingCreation.Callback, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable

public class C_PageComponent

extends com.cassinidivision.oce.content.base._C_PageComponent

A class representing an individual building-block of content (component) on a page.

Each page component is associated with a named template. The template meaning is abstract, but is commonly used to directly refer to the name of a WebObjects component for rendering.

Page components may contain one or more "niches" (individually named chunks of hypertext content). It is up to the template as to how the niches are interpreted at rendering time.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class com.webobjects.eocontrol.EOGenericRecord

EOGenericRecord._DictionaryBinding, EOGenericRecord._LazyDictionaryBinding

Nested classes inherited from class com.webobjects.eocontrol.EOCustomObject

EOCustomObject._BooleanFieldBinding, EOCustomObject._FieldBinding, EOCustomObject._LazyFieldBinding, EOCustomObject._NumberFieldBinding

Nested classes inherited from class com.webobjects.eocontrol.EOKeyValueCodingAdditions

EOKeyValueCodingAdditions.DefaultImplementation, EOKeyValueCodingAdditions.Utility

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Nested classes inherited from class com.webobjects.eocontrol.EOKeyValueCoding

EOKeyValueCoding._BestBindingCreation, EOKeyValueCoding._KeyBindingCreation, EOKeyValueCoding._StoredForwardingBinding

Nested classes inherited from class com.webobjects.foundation.NSValidation

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Nested classes inherited from class com.webobjects.eocontrol._EOPrivateMemento

_EOPrivateMemento.DefaultImplementation

Field Summary

Fields inherited from class com.webobjects.eocontrol.EOGenericRecord

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Constructor Summary

C_PageComponent()

Method Summary

NSArray	acceptableClassesOfChildren() Reports which classes of children are acceptable within the receiver.
void	appendExportXMLForPropertiesToString(StringBuffer returnString) Calculates the export XML string for all properties (child tags and child text) owned by the receiver, and appends it to the given string.
void	awakeFromInsertion(EOEditingContext ec) All newly-created content in the OCE system is immediately instantiated with the following values.
C_Content	copyIntoEC(EOEditingContext ec) Extends the superclass copy functionality to include the deep copying of child content.
StringBuffer	exportXMLForAttributes() Called during XML export: builds a StringBuffer holding all the attribute name="value" pairs for the receiver's XML.
C_Feature	feature() Convenience method: retrieve the feature that this component is part of.
C_FeaturePage	featurePage() Convenience method: retrieve the feature page that this component is part of.
int	nicheValueAsInt(String nicheName) Attempt to convert the value of the named niche to an int.
Integer	nicheValueAsInteger(String nicheName) Attempt to convert the value of the named niche as an Integer object.
String	nicheValueAsString(String nicheName) Retrieve a string representation of the named niche value, in the default XML format.
NSArray	orderedChildren() Note that page component children (niches) are ordered numerically rather than by name.
void	takeAttributesFromDictionary(NSDictionary pList) Sets up the receiver's instance variables from given values.

Methods inherited from class com.cassinidivision.oce.content.base._C_PageComponent

ordering, setOrdering, setTemplateName, templateName

Methods inherited from class com.cassinidivision.oce.content.C_ContentContainer

childContentWithName, contentAtContentPath, createNewChildOfClassWithStem, deleteChild, duplicateChild, fixHyperlinkPathsForImportedChildren, forceDeleteAllChildren, forceDeleteChild, globalIDsForSelfAndAllChildren, globalIDsForSelfAndAllLoadedChildren, longDebuggingOutput, nameForNewChildWithStem, renameChildToName, selfAndAllChildren, selfAndAllLoadedChildren, selfOrSomeDescendantPublished, startElementWithAttributes, willAcceptChild, willAcceptChildOfClass, willAcceptChildren

Methods inherited from class com.cassinidivision.oce.content.base._C_ContentContainer

addToChildren, children, removeFromChildren, setChildren

Methods inherited from class com.cassinidivision.oce.content.C_Content

addCAttributeWithValues, addCharacterData, allParents, appendExportXMLForAdditionalAttributesToString, appendExportXMLForAttributeNamedKeyPathToString, appendExportXMLForAttributeNamedValueToString, appendExportXMLForAttributesToString, appendExportXMLForAttributeToString, appendExportXMLForClosingTagToString, appendExportXMLForEmptyTagToString, appendExportXMLForObjectToString, appendExportXMLForOpeningTagToString, appendExportXMLForPropertyNamedKeyPathToString, appendExportXMLForPropertyNamedValueToString, appendExportXMLForPropertyToString, appendStringValueForPropertyToString, contentId, contentPath, contentWithContentIdInEditingContext, copyToNewParent, copyWithinEC, defaultXMLRepresentation, deleteSelf, endElement, forceDeleteSelf, moveToNewParent, renameSelf, setDataPropertyFromDictionary, setDatePropertyFromDictionary, setNumberPropertyFromDictionary, setStringPropertyFromDictionary, setStringPropertyNamedKeyPathFromDictionary, sortField, startCAttributeList

Methods inherited from class com.cassinidivision.oce.content.base._C_Content

addToXmlAttributes, className, creationDate, modificationDate, name, parent, removeFromXmlAttributes, setClassName, setCreationDate, setModificationDate, setName, setParent, setXmlAttributes, setXmlLabel, xmlAttributes, xmlLabel

Methods inherited from class com.webobjects.eocontrol.EOGenericRecord

__setClassDescription, _keyGetBindingForKey, _keySetBindingForKey, _otherStorageBinding, _storedKeyGetBindingForKey, _storedKeySetBindingForKey, classDescription, usesDeferredFaultCreation

Methods inherited from class com.webobjects.eocontrol.EOCustomObject

__classDescription, __clearPendingChanges, __editingContext, __globalID, __hasAuxillaryObservers, __hasPendingChanges, __hasPendingUpdate, __isInitialized, __isPendingDeletion, __isPendingInsertion, __isShared, __lastSnapshot, __originalSnapshot, __retainCount, __setAuxillaryObservers, __setEditingContext, __setGlobalID, __setInitialized, __setLastSnapshot, __setOriginalSnapshot, __setPendingDeletion, __setPendingInsertion, __setPendingUpdate, __setRetainCount, __setShared, _createKeyGetBindingForKey, _createKeySetBindingForKey, _createStoredKeyGetBindingForKey, _createStoredKeySetBindingForKey, _fieldKeyBinding, _forwardingBindingNeededForClass, _methodKeyGetBinding, _methodKeySetBinding, addObjectToBothSidesOfRelationshipWithKey, addObjectToPropertyWithKey, allPropertyKeys, attributeKeys, awakeFromClientUpdate, awakeFromFetch, canAccessFieldsDirectly, changesFromSnapshot, classDescriptionForDestinationKey, clearFault, clearProperties, deleteRuleForRelationshipKey, editingContext, entityName, eoDescription, eoShallowDescription, equals, faultHandler, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hashCode, inverseForRelationshipKey, invokeRemoteMethod, isFault, isToManyKey, opaqueState, ownsDestinationObjectsForRelationshipKey, prepareValuesForClient, propagateDeleteWithEditingContext, reapplyChangesFromDictionary, removeObjectFromBothSidesOfRelationshipWithKey, removeObjectFromPropertyWithKey, shouldUseStoredAccessors, snapshot, storedValueForKey, takeStoredValueForKey, takeValueForKey, takeValueForKeyPath, takeValuesFromDictionary, takeValuesFromDictionaryWithMapping, toManyRelationshipKeys, toOneRelationshipKeys, toString, turnIntoFault, unableToSetNullForKey, updateFromSnapshot, userPresentableDescription, validateClientUpdate, validateForDelete, validateForInsert, validateForSave, validateForUpdate, validateTakeValueForKeyPath, validateValueForKey, valueForKey, valueForKeyPath, valuesForKeys, valuesForKeysWithMapping, willChange, willRead, willReadRelationship

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

C_PageComponent

public C_PageComponent()

Method Detail

awakeFromInsertion

public void awakeFromInsertion(EOEditingContext ec)

Description copied from class: C_Content

All newly-created content in the OCE system is immediately instantiated with the following values.

• Content class name.
• Creation date set to the current time.
• Modification date set to the current time.

Specified by:

awakeFromInsertion in interface EOEnterpriseObject

Overrides:

awakeFromInsertion in class C_ContentContainer

copyIntoEC

public C_Content copyIntoEC(EOEditingContext ec)

Description copied from class: C_ContentContainer

Extends the superclass copy functionality to include the deep copying of child content.

Overrides:

copyIntoEC in class C_ContentContainer

Parameters:

ec - editing context to copy into

Returns:

the new copy

See Also:

C_Content.copyIntoEC(com.webobjects.eocontrol.EOEditingContext)

acceptableClassesOfChildren

public NSArray acceptableClassesOfChildren()

Description copied from class: C_ContentContainer

Reports which classes of children are acceptable within the receiver.

The base implementation returns an empty array.

Overrides:

acceptableClassesOfChildren in class C_ContentContainer

Returns:

array of acceptable classes

appendExportXMLForPropertiesToString

public void appendExportXMLForPropertiesToString(StringBuffer returnString)

Description copied from class: C_ContentContainer

Calculates the export XML string for all properties (child tags and child text) owned by the receiver, and appends it to the given string.

Overrides:

appendExportXMLForPropertiesToString in class C_ContentContainer

Parameters:

returnString - StringBuffer to which the result will be appended

See Also:

C_Content.appendExportXMLForPropertiesToString(java.lang.StringBuffer)

exportXMLForAttributes

public StringBuffer exportXMLForAttributes()

Description copied from class: C_Content

Called during XML export: builds a StringBuffer holding all the attribute name="value" pairs for the receiver's XML.

Overrides:

exportXMLForAttributes in class C_ContentContainer

takeAttributesFromDictionary

public void takeAttributesFromDictionary(NSDictionary pList)

Description copied from class: C_Content

Sets up the receiver's instance variables from given values.

The values will normally have come from the attributes of an XML start element tag.

Overrides:

takeAttributesFromDictionary in class C_Content

Parameters:

pList - The dictionary of values.

nicheValueAsString

public String nicheValueAsString(String nicheName)

Retrieve a string representation of the named niche value, in the default XML format.

Parameters:

nicheName - name of a niche

Returns:

string containing an XML representation, or the empty string if there was no corresponding niche

nicheValueAsInteger

public Integer nicheValueAsInteger(String nicheName)

Attempt to convert the value of the named niche as an Integer object.

Parameters:

nicheName - name of the niche

Returns:

Integer object, or null if the niche is absent/the value could not be converted

nicheValueAsInt

public int nicheValueAsInt(String nicheName)

Attempt to convert the value of the named niche to an int.

Parameters:

nicheName - name of the niche

Returns:

int value, or 0 if the niche is absent/the value could not be converted

feature

public C_Feature feature()

Convenience method: retrieve the feature that this component is part of.

Returns:

the related feature

featurePage

public C_FeaturePage featurePage()

Convenience method: retrieve the feature page that this component is part of.

Returns:

the related feature

orderedChildren

public NSArray orderedChildren()

Note that page component children (niches) are ordered numerically rather than by name.

Overrides:

orderedChildren in class C_ContentContainer

Returns:

sorted array of children

See Also:

C_ContentContainer.orderedChildren()