Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AcfResult() - Constructor for class com.arbortext.e3ci.Manager.AcfResult
- AcfResult(int, String[], String[], String[], String[], String[], String[], String[]) - Constructor for class com.arbortext.e3ci.Manager.AcfResult
- AcvResult() - Constructor for class com.arbortext.e3ci.Manager.AcvResult
- AcvResult(int, String[], String[], String[]) - Constructor for class com.arbortext.e3ci.Manager.AcvResult
- addAppConfigFile(CCAppConfigFile) - Method in class com.arbortext.e3ci.CompConfig
-
Adds a new top-level APP configuration file
- addAppConfigFile(CCAppConfigFile) - Method in class com.arbortext.e3ci.Doctype
-
Adds a new APP config file to the list
- addAppConfigFiles(List<APPConfigFile>) - Method in class com.arbortext.e3ci.Doctype
-
Adds APP config files from an Arbortext Editor list of descriptors.
- addComposer(CCDocumentComposer) - Method in class com.arbortext.e3ci.Doctype
-
Adds a new composer descriptor to the composer list
- addComposer(DocumentComposer) - Method in class com.arbortext.e3ci.DocConfigFile
-
Adds a new document type/composer association object
- addConsoleLogger() - Static method in class com.arbortext.epic.prdata.Database
-
Adds an appender that writes our internal behavior to the ATITrace window (Windows) or Tomcat log (Unix).
- addDoctype(String) - Method in class com.arbortext.e3ci.Rule
-
Adds a new doctype to our supported list.
- addFile(String) - Method in class com.arbortext.e3ci.PathEntry
-
Adds a file to the list of files in this directory
- addFile(String, String, long) - Method in class com.arbortext.e3ci.PathEntry
-
Adds a file to the list of files with its details.
- addFileWithPath(String) - Method in class com.arbortext.e3ci.PathEntry
-
Adds a file specified by absolute pathname.
- addFrameset(CCFrameset) - Method in class com.arbortext.e3ci.DocConfigFile
-
Adds a new frameset descriptor
- addFrameSet(CCFrameset) - Method in class com.arbortext.e3ci.Doctype
-
Adds a new frameset descriptor to the frameset list
- addMember(String, String) - Method in class com.arbortext.e3ci.RuleSet
- addMessage(String) - Method in class com.arbortext.epic.prdata.MessageHolder
-
Adds a new message to our list.
- addModification(Modification) - Method in class com.arbortext.epic.prdata.RuleFile
-
Modifies one of the objects in this rule file and track the change so that it can be undone later.
- addNewRule(Rule) - Method in class com.arbortext.epic.prdata.RuleFile
-
Adds a new rule to our data structures.
- addNewSet(RuleSet) - Method in class com.arbortext.epic.prdata.RuleFile
-
Adds a new rule set to our data structures.
- addOperation(Operation) - Method in class com.arbortext.epic.prdata.Database
-
Inserts a rule or rule set into our global map.
- addOperationType(CCOperationType) - Method in class com.arbortext.e3ci.RuleFile
-
Adds a new operation type
- addParameter(CCCompositionParameter) - Method in class com.arbortext.e3ci.Composer
-
Adds a new parameter
- addParameter(String, String) - Method in class com.arbortext.e3ci.DocumentComposer
-
Adds a parameter to our parameter store
- addParameter(String, String) - Method in class com.arbortext.e3ci.Rule
-
Adds a new parameter to our list
- addParameter(String, String) - Method in class com.arbortext.e3ci.RuleSet
-
Adds a new parameter
- addPublicId(String) - Method in class com.arbortext.e3ci.Doctype
-
Adds a new public ID to the public ID list
- addRule(CCRule) - Method in class com.arbortext.e3ci.RuleFile
-
Adds a new rule
- addRuleSet(CCRuleSet) - Method in class com.arbortext.e3ci.RuleFile
-
Adds a new rule set
- addServerParameter(String, String) - Method in class com.arbortext.e3ci.CompConfig
-
Adds a new PE server global parameter
- addStyleSheet(CCStylesheet) - Method in class com.arbortext.e3ci.Doctype
-
Adds a new stylesheet descriptor to the stylesheet list.
- addStylesheetOrdering(String, List) - Method in class com.arbortext.e3ci.Doctype
-
Adds a stylesheet ordering list for a particular composition type.
- addStylesheetOrdering(String, List<String>) - Method in class com.arbortext.e3ci.DocConfigFile
-
Adds a new stylesheet ordering
- addSystemIdMapping(String) - Method in class com.arbortext.e3ci.Doctype
-
Adds a new System ID to the list of system IDs mapped to this doctype.
- addUriMapping(String) - Method in class com.arbortext.e3ci.Doctype
-
Adds a new URI to this doctype's mappings
- and tags - Search tag in com.arbortext.e3ci.CompConfig.toStringHtml(String, String, boolean, boolean)
- Section
- and tags - Search tag in com.arbortext.e3ci.CompConfigServer.serializeHtml(File, String, String, boolean, boolean)
- Section
- and tags - Search tag in com.arbortext.e3ci.CompositionConfiguration.toStringHtml(String, String, boolean, boolean)
- Section
- AppConfigFile - Class in com.arbortext.e3ci
-
Describes an APP (advanced print publisher) configuration file.
- AppConfigFile(APPConfigFile) - Constructor for class com.arbortext.e3ci.AppConfigFile
-
Initializes a new descriptor with information for the Editor's 'find local APP Config File' subsystem.
- AppConfigFile(String, String, String, String, String, String, long, String, String) - Constructor for class com.arbortext.e3ci.AppConfigFile
-
Initializes a new descriptor with file information.
- AppConfigFile(String, String, String, String, String, String, String) - Constructor for class com.arbortext.e3ci.AppConfigFile
-
Initializes a new descriptor.
- Application - Class in com.arbortext.e3ci
-
E3 Application to return CompConfig data
- Application() - Constructor for class com.arbortext.e3ci.Application
-
Initializes this instance
- ApplicationClientVersion - Class in com.arbortext.e3ci
-
Describes a single client version supported by a packaged application installed on a PE server.
- ApplicationClientVersion(String, String, String) - Constructor for class com.arbortext.e3ci.ApplicationClientVersion
-
Initializes a new object
- AppMd5 - Class in com.arbortext.e3ci
-
E3 Application to check that files on the server have the same MD5 checksums as the corresponding files on the client.
- AppMd5() - Constructor for class com.arbortext.e3ci.AppMd5
- Author - Class in com.arbortext.epic.prdata
- Author(AuthorDefinition) - Constructor for class com.arbortext.epic.prdata.Author
-
Creates an object from a stanza in an XML rule file
- Author(Author, boolean) - Constructor for class com.arbortext.epic.prdata.Author
-
Creates an object from another object
- AuthorInstalledApplication - Class in com.arbortext.epic.prdata
-
Describes an Arborext packaged application that was installed and active when a rule file was created.
- AuthorInstalledApplication(String, File, String) - Constructor for class com.arbortext.epic.prdata.AuthorInstalledApplication
-
Initializes a new object
B
- buildCompConfig(String, int, String, String, String) - Static method in class com.arbortext.e3ci.CompConfigServer
-
Deprecated, for removal: This API element is subject to removal in a future version.Not used
C
- cancelModifications() - Method in class com.arbortext.epic.prdata.RuleFile
-
Undoes all unsaved modifications.
- canCompose(int, boolean, String) - Method in class com.arbortext.epic.prdata.Database
-
Indicates whether a given operation (rule or rule set) can compose documents with a specific document type.
- canCompose(String, PRLocation, Database) - Method in class com.arbortext.epic.prdata.Operation
-
Indicates whether this Rule Set can be used to compose a given document type on either the server or client machine.
- canCompose(String, PRLocation, Database) - Method in class com.arbortext.epic.prdata.Rule
-
Indicates whether this Rule can be used to compose a given document type on either the server or client machine.
- canCompose(String, PRLocation, Database) - Method in class com.arbortext.epic.prdata.RuleSet
-
Indicates whether this Rule Set can be used to compose a given document type on either the server or client machine.
- CCAppConfigFile - Interface in com.arbortext.e3ci
-
Describes an APP (advanced print publisher) configuration file.
- CCApplication - Interface in com.arbortext.e3ci
-
Describes a single packaged application installed in a PE Subprocess.
- CCApplicationClientVersion - Interface in com.arbortext.e3ci
-
Describes a single client supported by a packaged application.
- CCComposer - Interface in com.arbortext.e3ci
-
Describes a single composer (.ccf file) associated with a doctype installed on an E3 server.
- CCCompositionParameter - Interface in com.arbortext.e3ci
-
Describes a single parameter to an Epic composer (.ccf file).
- CCDmpTemplate - Interface in com.arbortext.e3ci
-
Describes a DMP template on a PE server.
- CCDoctype - Interface in com.arbortext.e3ci
-
Provides composition configuration information about a single doctype that is installed on the E3 server.
- CCDocumentComposer - Interface in com.arbortext.e3ci
-
Describes a composer associated with a document type installed on an E3 server.
- CCFileDetails - Interface in com.arbortext.e3ci
-
Interface for file details.
- CCFrameset - Interface in com.arbortext.e3ci
-
Describes a frameset associated with a document type that is installed on an E3 server.
- CCImportTemplate - Interface in com.arbortext.e3ci
-
Describes a template file used by CDOCS document import pprocessor.
- CCOperationType - Interface in com.arbortext.e3ci
-
Describes a composition operation defined in a rule file.
- CCPathEntry - Interface in com.arbortext.e3ci
-
Describes a single directory on a server path list.
- CCRule - Interface in com.arbortext.e3ci
-
Describes a publishing rule.
- CCRuleFile - Interface in com.arbortext.e3ci
-
Describes a Publishing Rule file on the PE server.
- CCRuleSet - Interface in com.arbortext.e3ci
-
Describes a publishing rule set.
- CCRuleSet.MemberRule - Interface in com.arbortext.e3ci
-
Private interface identifying a single rule in this rule set.
- CCStylesheet - Interface in com.arbortext.e3ci
-
Describes a stylesheet associated with a document type installed on an E3 server
- CCStylesheetInfoKey - Enum Class in com.arbortext.e3ci
- clearMessage() - Method in class com.arbortext.epic.prdata.MessageHolder
-
Deletes every message in our list.
- client(String[], String[]) - Static method in class com.arbortext.e3ci.AppMd5
-
Client routine: calls the E3 AppMd5 application to check a list of files.
- com.arbortext.e3ci - package com.arbortext.e3ci
- com.arbortext.epic.prdata - package com.arbortext.epic.prdata
- CompConfig - Class in com.arbortext.e3ci
-
Describes the information in a document returned by E3 f=compinfo.
- CompConfig() - Constructor for class com.arbortext.e3ci.CompConfig
-
Initializes to an empty state
- CompConfigComparator - Class in com.arbortext.e3ci
-
Composition Configuration Comarator class.
- CompConfigComparator(CompositionConfiguration, CompositionConfiguration) - Constructor for class com.arbortext.e3ci.CompConfigComparator
-
Constructor that computes the difference between the two CompositionCofigurations.
- CompConfigLocal - Class in com.arbortext.e3ci
-
CompConfig object which initializes itself by scanning the Epic install tree and APTCUSTOM directories.
- CompConfigLocal() - Constructor for class com.arbortext.e3ci.CompConfigLocal
-
Initializes a CompConfig document by scanning the Epic install tree.
- CompConfigLocal(boolean) - Constructor for class com.arbortext.e3ci.CompConfigLocal
-
Initializes a CompConfig document by scanning the Epic install tree.
- CompConfigRemote - Class in com.arbortext.e3ci
-
Reads composition configuration from an XML document.
- CompConfigRemote(File) - Constructor for class com.arbortext.e3ci.CompConfigRemote
-
Initializes by parsing an XML document
- CompConfigRemote(File, boolean) - Constructor for class com.arbortext.e3ci.CompConfigRemote
-
Initializes by parsing an XML document
- CompConfigRemote(String) - Constructor for class com.arbortext.e3ci.CompConfigRemote
-
Initializes by parsing an XML file
- CompConfigServer - Class in com.arbortext.e3ci
-
Called by Epic running as an E3 subprocess to scan the E3 server's composition configuration and write the result to an XML file.
- CompConfigServer(String, String, String) - Constructor for class com.arbortext.e3ci.CompConfigServer
-
Initializes by scanning the Epic install tree
- Composer - Class in com.arbortext.e3ci
-
Describes a single Epic Composer (i.e., a .ccf) in a CompInfo document
- Composer(String) - Constructor for class com.arbortext.e3ci.Composer
-
Initializes a new Composer object
- composesDoctype(String) - Method in interface com.arbortext.epic.prdata.PRRule
-
Indicates whether this operation can compose a document of a given type.
- composesDoctype(String) - Method in class com.arbortext.epic.prdata.Rule
-
Indicates whether this operation can compose a document of a given type.
- CompositionConfiguration - Interface in com.arbortext.e3ci
-
Provides information about an E3 server's composition capabilities.
- CompositionParameter - Class in com.arbortext.e3ci
-
Describes a single Epic Composer (.ccf file) parameter
- CompositionParameter(String, String, String, boolean, String, String[]) - Constructor for class com.arbortext.e3ci.CompositionParameter
- compute(File) - Method in class com.arbortext.e3ci.FileMd5Generator
-
Computes an MD5 digest for a file
- contains(Rule) - Method in class com.arbortext.epic.prdata.RuleSet
-
Indicates whether we contain a particular rule.
- containsMappedSystemId(String) - Method in interface com.arbortext.e3ci.CCDoctype
-
Indicates whether a given system ID is mapped to this doctype.
- containsMappedSystemId(String) - Method in class com.arbortext.e3ci.Doctype
-
Contains whether a given system ID is mapped to this doctype.
- containsNamespaceURI(String) - Method in interface com.arbortext.e3ci.CCDoctype
-
Indicates whether this document type corresponds to a given namespace URI.
- containsNamespaceURI(String) - Method in class com.arbortext.e3ci.Doctype
-
Indicates whether this document type corresponds to a given namespace URI.
- containsPublicId(String) - Method in interface com.arbortext.e3ci.CCDoctype
-
Indicates whether this document type corresponds to a given public ID
- containsPublicId(String) - Method in class com.arbortext.e3ci.Doctype
-
Indicates whether a given doctype corresponds to a public ID
- createRuleFile(String, String, String) - Method in class com.arbortext.epic.prdata.Database
-
Creates a new rule file
D
- Database - Class in com.arbortext.epic.prdata
-
Publishing Rule Database.
- deleteMember(int) - Method in class com.arbortext.epic.prdata.RuleSet
-
Deletes a member.
- deleteOperation(int) - Method in class com.arbortext.epic.prdata.Database
-
Deletes an operation from our global map.
- deleteParameter(Parameter) - Method in class com.arbortext.epic.prdata.Operation
-
Deletes a parameter from our store
- deleteRule(Rule) - Method in class com.arbortext.epic.prdata.RuleFile
-
Deletes a rule from this rule set's data structures.
- deleteSet(RuleSet) - Method in class com.arbortext.epic.prdata.RuleFile
-
Deletes a rule set from this rule set's data structures.
- DeletionLocation(int, int) - Constructor for class com.arbortext.epic.prdata.RuleFile.DeletionLocation
- describe(Writer) - Method in class com.arbortext.e3ci.CompConfigComparator
-
Describes the difference between the client and server as a XHTML document.
- describeApplicationDifference(Writer, CompConfigComparator.MapDifference) - Static method in class com.arbortext.e3ci.CompConfigComparator
-
Describes the difference between the applications.
- describeFileDetailsDifference(Writer, CompConfigComparator.MapDifference) - Static method in class com.arbortext.e3ci.CompConfigComparator
-
Describes the difference between Maps of
FileDetails. - describeSectionDifference(Writer, CompConfigComparator.MapDifference) - Static method in class com.arbortext.e3ci.CompConfigComparator
-
Describe the difference between two sections.
- DESCRIPTION - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- destroy() - Method in class com.arbortext.e3ci.Application
-
Called before we're unloaded
- destroy() - Method in class com.arbortext.e3ci.AppMd5
-
Called before we're unloaded
- DIRECTORY_ONLY - Enum constant in enum class com.arbortext.epic.prdata.PROperationType.ResultType
- DmpTemplate - Class in com.arbortext.e3ci
-
Describes a DMP template on the PE server.
- DmpTemplate(String, String) - Constructor for class com.arbortext.e3ci.DmpTemplate
-
Initializes a new template descriptor.
- DocConfigFile - Class in com.arbortext.e3ci
-
Describes the content of a document configuration file that's relevant to the composition configuration scan.
- DocConfigFile(File) - Constructor for class com.arbortext.e3ci.DocConfigFile
-
Creates a new object
- Doctype - Class in com.arbortext.e3ci
-
Class to hold information about a single doctype in a CompInfo document.
- Doctype - Class in com.arbortext.epic.prdata
-
Represents a document type that can be associated wth a publishing rule.
- Doctype(String) - Constructor for class com.arbortext.e3ci.Doctype
-
Creates a new document type descriptor
- Doctype(String) - Constructor for class com.arbortext.epic.prdata.Doctype
-
Creates a new object.
- Doctype(String, File) - Constructor for class com.arbortext.e3ci.Doctype
-
Creates a new document type descriptor.
- DOCTYPE_CONFIG_ELEMENT - Static variable in class com.arbortext.e3ci.CompConfig
- DocumentComposer - Class in com.arbortext.e3ci
-
Describes a composer associated with a document type installed on an E3 server.
- DocumentComposer(String, String) - Constructor for class com.arbortext.e3ci.DocumentComposer
-
Initializes a new DocumentComposer object
- doGet(E3ApplicationRequest, E3ApplicationResponse) - Method in class com.arbortext.e3ci.Application
-
called to serve a user's GET request
- doGet(E3ApplicationRequest, E3ApplicationResponse) - Method in class com.arbortext.e3ci.AppMd5
-
called to serve a user's GET request
- doPost(E3ApplicationRequest, E3ApplicationResponse) - Method in class com.arbortext.e3ci.Application
-
called to serve a user's POST request
- doPost(E3ApplicationRequest, E3ApplicationResponse) - Method in class com.arbortext.e3ci.AppMd5
-
called to serve a user's POST request
- DtiResult() - Constructor for class com.arbortext.e3ci.Manager.DtiResult
- DtiResult(int, String[], String[]) - Constructor for class com.arbortext.e3ci.Manager.DtiResult
- dump() - Method in class com.arbortext.epic.prdata.Database
-
Writes out the contents of all known rule files.
E
- endRule(Map<String, String>) - Method in class com.arbortext.epic.prdata.RuleSetManifest
-
Terminate the description of a rule's execution in the rule set manifest.
- endSet(Map<String, String>) - Method in class com.arbortext.epic.prdata.RuleSetManifest
-
Terminates a manifest file describing the execution of a rule set.
- ENGINE - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- equals(Object) - Method in interface com.arbortext.e3ci.CCFileDetails
-
Returns true when files contents are equal.
- equals(Object) - Method in class com.arbortext.e3ci.FileDetails
-
Returns true when files contents are equal.
- equals(Object) - Method in class com.arbortext.e3ci.PackagedApplication
-
Determines if two PackagedApplications are the same.
- execute() - Method in class com.arbortext.epic.prdata.ModCreateRule
-
Adds our rule to its rule file and the global database.
- execute() - Method in class com.arbortext.epic.prdata.ModCreateSet
-
Adds our rule set to its rule file and to the global database
- execute() - Method in class com.arbortext.epic.prdata.ModDeleteRule
-
Deletes our rule from its rule file and from the global database
- execute() - Method in class com.arbortext.epic.prdata.ModDeleteSet
-
Deletes our rule set from its rule file and from the global database
- execute() - Method in class com.arbortext.epic.prdata.ModDescription
-
Changes an operation's description.
- execute() - Method in interface com.arbortext.epic.prdata.Modification
-
Executes whatever change this object encapsulates.
- execute() - Method in class com.arbortext.epic.prdata.ModMemberAdd
-
Adds a member rule to a rule set
- execute() - Method in class com.arbortext.epic.prdata.ModMemberDelete
-
Deletes a member rule from a rule set.
- execute() - Method in class com.arbortext.epic.prdata.ModMemberMove
-
Moves a rule up or down one position in its rule set.
- execute() - Method in class com.arbortext.epic.prdata.ModParameterAdd
-
Insert a parameter
- execute() - Method in class com.arbortext.epic.prdata.ModParameterDelete
-
Deletes a parameter
- execute() - Method in class com.arbortext.epic.prdata.ModParameterModify
-
Modifies parameter value
- execute(ADocument, Map<String, String>) - Method in class com.arbortext.epic.prdata.Operation
-
Publishes a document using a rule or rule set.
- execute(ADocument, Map<String, String>) - Method in interface com.arbortext.epic.prdata.PROperation
-
Publishes a document using a rule or rule set.
F
- FILE_ONLY - Enum constant in enum class com.arbortext.epic.prdata.PROperationType.ResultType
- FILE_WITH_DIRECTORY - Enum constant in enum class com.arbortext.epic.prdata.PROperationType.ResultType
- FileDetails - Class in com.arbortext.e3ci
-
Class for file details.
- FileDetails(String) - Constructor for class com.arbortext.e3ci.FileDetails
-
Constructs a
FileDetailsobject given the path by reading the file to determine details. - FileDetails(String, String, long) - Constructor for class com.arbortext.e3ci.FileDetails
-
Constructs a
FileDetailsobject from the details. - FileMd5Generator - Class in com.arbortext.e3ci
-
Generates md5 values of files.
- find(boolean) - Static method in class com.arbortext.epic.prdata.Database
-
Returns our singleton instance.
- findApplication(String) - Method in class com.arbortext.e3ci.CompConfig
-
Returns a descriptor for a packaged application.
- findApplication(String) - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns a descriptor for a packaged application.
- findComposer(String) - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns a doctype-specific composer
- findComposer(String) - Method in class com.arbortext.e3ci.Doctype
-
Returns a doctype-specific composer
- findComposer(String, boolean) - Method in class com.arbortext.e3ci.CompConfig
-
Returns a descriptor for a composer
- findComposer(String, boolean) - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns a descriptor for a composer
- findComposers(String, String) - Method in class com.arbortext.e3ci.CompConfig
-
Returns a composer and doctype-specific composer information
- findComposers(String, String) - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns a composer and doctype-specific composer information
- findDocumentType(String) - Method in class com.arbortext.e3ci.CompConfig
-
Returns a document type descriptor
- findDocumentType(String) - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns a descriptor for a document type
- findFileInPath(String, String) - Method in class com.arbortext.e3ci.Manager
-
Searches a path list (such as the composer path) for a file
- findOperation(Class<T>, String) - Method in class com.arbortext.epic.prdata.RuleFile
-
Returns a Rule or RuleSet object
- findOperation(String, String) - Method in class com.arbortext.epic.prdata.Database
-
Finds a rule or rule set.
- findParameter(String) - Method in interface com.arbortext.e3ci.CCComposer
-
Returns a descriptor for a specific parameter
- findParameter(String) - Method in interface com.arbortext.e3ci.CCDocumentComposer
-
Returns the value for a particular parameter.
- findParameter(String) - Method in class com.arbortext.e3ci.Composer
-
Returns a descriptor for a specific parameter
- findParameter(String) - Method in class com.arbortext.e3ci.DocumentComposer
-
Returns the value for a particular parameter.
- findParameter(String) - Method in class com.arbortext.epic.prdata.Operation
-
Returns a parameter object from our list.
- findParameterIndex(String) - Method in class com.arbortext.epic.prdata.Operation
- findType(String) - Method in class com.arbortext.epic.prdata.RuleFile
-
Returns a specified operation type.
- Frameset - Class in com.arbortext.e3ci
-
Class to describe a single frameset in a CompInfo document
- Frameset(String, String) - Constructor for class com.arbortext.e3ci.Frameset
-
Initializes a new frameset descriptor; the type defaults to 'old'.
- Frameset(String, String, String) - Constructor for class com.arbortext.e3ci.Frameset
-
Initializes a new frameset descriptor.
- FsiResult() - Constructor for class com.arbortext.e3ci.Manager.FsiResult
- FsiResult(int, String[], String[]) - Constructor for class com.arbortext.e3ci.Manager.FsiResult
G
- GaiResult() - Constructor for class com.arbortext.e3ci.Manager.GaiResult
- GaiResult(int, String[], String[], String[], String[], String[]) - Constructor for class com.arbortext.e3ci.Manager.GaiResult
- GEN_TAGGED_PDF - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- getAlternateStylesheetDirectory() - Method in class com.arbortext.e3ci.DocConfigFile
-
Returns the alternate stylesheet directory, if any
- getAnnotation() - Method in interface com.arbortext.e3ci.CCImportTemplate
-
Returns string indicating this template's function or use.
- getAnnotation() - Method in class com.arbortext.e3ci.ImportTemplate
-
Returns string indicating this template's function or use.
- getAnnotations() - Method in class com.arbortext.e3ci.Manager.ImResult
- getAppConfigFiles() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns the doctype's APP configuration files.
- getAppConfigFiles() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the APP configuration files that are not associated with a particular doctype.
- getAppConfigFiles() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the APP configuration files that are not associated with a particular doctype.
- getAppConfigFiles() - Method in class com.arbortext.e3ci.Doctype
-
Returns the doctype's APP configuration files.
- getAppConfigFiles(String, String) - Method in class com.arbortext.e3ci.Manager
-
Returns information about APP configuration files
- getApplicationClientVersions(String) - Method in class com.arbortext.e3ci.Manager
-
Returns information about the client-installed versions a server-installed application supports.
- getApplicationInfo() - Method in class com.arbortext.e3ci.Manager
-
Returns information about packaged applications installed on the PE server.
- getApplications() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the installed packaged applications
- getApplications() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the installed packaged applications.
- getApplications() - Method in class com.arbortext.epic.prdata.Author
-
Returns the list of applications that were installed and active at the time a rule file was created.
- getApplications() - Method in interface com.arbortext.epic.prdata.PRAuthor
-
Returns the list of applications that were installed and active at the time a rule file was created.
- getAuthor() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Returns a descriptor for the program that created this file.
- getAuthor() - Method in class com.arbortext.epic.prdata.RuleFile
-
Returns a descriptor for the program that created this file.
- getClientVersionNumbers() - Method in class com.arbortext.e3ci.CompConfig
-
Returns a list of version strings, each indicating support for a particular version of Arbortext Editor.
- getClientVersionNumbers() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns a list of version strings, each indicating support for a particular version of Arbortext Editor.
- getClientVersions() - Method in interface com.arbortext.e3ci.CCApplication
-
Returns a list of versions of the application that might be installed on a client machine and which this server-installed application can support.
- getClientVersions() - Method in class com.arbortext.e3ci.Manager
-
Returns the client versions of Arbortext Editor supported by the PE server.
- getClientVersions() - Method in class com.arbortext.e3ci.PackagedApplication
-
Returns a list of versions of the application that might be installed on a client machine and which this server-installed application can support.
- getComposerPath(String, String) - Method in class com.arbortext.e3ci.Manager
-
Returns the absolute path on the E3 server to the composer (.ccf) file to be used with the doctype with the indicated public ID
- getComposers() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns the composers associated with this document type.
- getComposers() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the configured composers
- getComposers() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the configured composers
- getComposers() - Method in class com.arbortext.e3ci.DocConfigFile
-
Returns a list of composer/doctype interaction objects.
- getComposers() - Method in class com.arbortext.e3ci.Doctype
-
Returns an iterator to the list of composers
- getCompositionFunction() - Method in interface com.arbortext.e3ci.CCOperationType
-
Returns the ACL function that performs this operation.
- getCompositionFunction() - Method in class com.arbortext.e3ci.OperationType
-
Returns the ACL function that performs this operation.
- getCompositionFunction() - Method in class com.arbortext.epic.prdata.OperationType
-
Returns the name of the ACL function (with no leading package name) that should be called to start composing a document.
- getCompositionFunction() - Method in interface com.arbortext.epic.prdata.PROperationType
-
Returns the name of the ACL function (with no leading package name) that should be called to start composing a document.
- getCompositionParameterInfo(String, String, String) - Method in class com.arbortext.e3ci.Manager
-
Returns information about a composition parameter
- getCompositionParameters(String, String) - Method in class com.arbortext.e3ci.Manager
-
Returns a map containing the default composition parameters for a composer and a doctype
- getCompositionPath() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the directories in the server's composition path list.
- getCompositionPath() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the directories in the server's composition path list.
- getConfig() - Method in class com.arbortext.e3ci.Manager
-
Returns the configuration corresponding to the current global Epic "e3serverurl" option or null if the URL is invalid or the E3 server is down.
- getConfig(String) - Static method in class com.arbortext.e3ci.Manager
-
Returns the configuration object for an E3 URL
- getConfigFiles() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns a PathEntry containing files that define this Doctype.
- getConfigFiles() - Method in class com.arbortext.e3ci.Doctype
-
Returns a PathEntry containing files that define this Doctype.
- getContainingRuleSetCount(int) - Method in class com.arbortext.epic.prdata.Database
-
Returns the number of rule sets that contain a publishing rule.
- getCount() - Method in class com.arbortext.e3ci.Manager.AcfResult
- getCount() - Method in class com.arbortext.e3ci.Manager.AcvResult
- getCount() - Method in class com.arbortext.e3ci.Manager.DtiResult
- getCount() - Method in class com.arbortext.e3ci.Manager.FsiResult
- getCount() - Method in class com.arbortext.e3ci.Manager.GaiResult
- getCount() - Method in class com.arbortext.e3ci.Manager.GsiResult
- getCount() - Method in class com.arbortext.e3ci.Manager.ImResult
- getCurrentConfiguration() - Static method in class com.arbortext.epic.prdata.Author
-
Returns a descriptor for the currently-running application.
- getCustomDirs() - Method in class com.arbortext.epic.prdata.Author
-
Returns the list of custom directories installed and active at the time a rule file was created.
- getCustomDirs() - Method in interface com.arbortext.epic.prdata.PRAuthor
-
Returns the list of custom directories installed and active at the time a rule file was created.
- getCuttingGuides() - Method in class com.arbortext.e3ci.AppConfigFile
-
Returns the cuttingGuides attribute (crop marks).
- getCuttingGuides() - Method in interface com.arbortext.e3ci.CCAppConfigFile
-
Returns the cuttingGuides attribute (crop marks).
- getCuttingGuides() - Method in class com.arbortext.e3ci.Manager.AcfResult
- getData(Map<String, String>, Database) - Method in class com.arbortext.epic.prdata.Operation
-
Returns information about this rule or rule set in an associative array.
- getData(Map<String, String>, Database) - Method in class com.arbortext.epic.prdata.Rule
-
Returns information about this operation as an associative array.
- getData(Map<String, String>, Database) - Method in class com.arbortext.epic.prdata.RuleSet
-
Returns information about this operation as an associative array.
- getDate() - Method in interface com.arbortext.e3ci.CCApplication
-
Returns the release date of this packaged application.
- getDate() - Method in class com.arbortext.e3ci.PackagedApplication
-
Returns the release date of this packaged application.
- getDates() - Method in class com.arbortext.e3ci.Manager.GaiResult
- getDefaultValue() - Method in interface com.arbortext.e3ci.CCCompositionParameter
-
Returns the default parameter value, if any.
- getDefaultValue() - Method in class com.arbortext.e3ci.CompositionParameter
-
Returns the default parameter value, if any.
- getDeprecated() - Method in interface com.arbortext.e3ci.CCOperationType
-
Returns an indication of whether this output type is deprecated.
- getDeprecated() - Method in class com.arbortext.e3ci.OperationType
-
Returns an indication of whether this output type is deprecated.
- getDeprecated() - Method in class com.arbortext.epic.prdata.OperationType
-
Returns an indication of whether this operation is deprecated i.e., no longer supported).
- getDeprecated() - Method in interface com.arbortext.epic.prdata.PROperationType
-
Returns an indication of whether this operation type is deprecated (i.e., no longer supported).
- getDescription() - Method in interface com.arbortext.e3ci.CCApplication
-
Returns the description of this packaged application.
- getDescription() - Method in interface com.arbortext.e3ci.CCFrameset
-
Returns frameset description
- getDescription() - Method in interface com.arbortext.e3ci.CCOperationType
-
Returns this operation's description.
- getDescription() - Method in interface com.arbortext.e3ci.CCRule
-
Returns a user-friendly description of this rule.
- getDescription() - Method in interface com.arbortext.e3ci.CCRuleSet
-
Returns a user-friendly description of this rule set.
- getDescription() - Method in class com.arbortext.e3ci.Frameset
-
Accessor for frameset description
- getDescription() - Method in class com.arbortext.e3ci.OperationType
-
Returns this operation's description.
- getDescription() - Method in class com.arbortext.e3ci.PackagedApplication
-
Returns the description of this packaged application.
- getDescription() - Method in class com.arbortext.e3ci.Rule
-
Returns a user-friendly description of this rule.
- getDescription() - Method in class com.arbortext.e3ci.RuleSet
-
Returns a user-friendly description of this rule set.
- getDescription() - Method in interface com.arbortext.epic.prdata.PRRuleFileEntry
-
Returns a text description of this entry.
- getDescription() - Method in class com.arbortext.epic.prdata.RuleFileEntry
-
Returns a text description of this entry.
- getDescriptions() - Method in class com.arbortext.e3ci.Manager.GaiResult
- getDetails() - Method in class com.arbortext.e3ci.AppConfigFile
-
Returns details (last change date, checksum) about the config file.
- getDetails() - Method in interface com.arbortext.e3ci.CCAppConfigFile
-
Returns details (last change date, checksum) about the config file.
- getDetails() - Method in interface com.arbortext.e3ci.CCImportTemplate
-
Returns the CCFileDetails of the import template file.
- getDetails() - Method in class com.arbortext.e3ci.ImportTemplate
-
Returns the CCFileDetails of the import template file.
- getDetails(String) - Method in interface com.arbortext.e3ci.CCPathEntry
-
Returns a CCFileDetails interface for the specified file.
- getDetails(String) - Method in class com.arbortext.e3ci.PathEntry
-
Returns a CCFileDetails interface for the specified file.
- getDetailsMap() - Method in interface com.arbortext.e3ci.CCPathEntry
-
Returns a Map of CCFileDetails keyed by file name.
- getDetailsMap() - Method in class com.arbortext.e3ci.PathEntry
-
Returns a Map of CCFileDetails keyed by file name.
- getDmpTemplateCount() - Method in class com.arbortext.e3ci.Manager
-
Returns the number of known DMP templates
- getDmpTemplateInfo() - Method in class com.arbortext.e3ci.Manager
-
Returns information about DMP template directories
- getDmpTemplatePath(int) - Method in class com.arbortext.e3ci.Manager
-
Returns the path to a DMP template
- getDmpTemplates() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the DMP templates.
- getDmpTemplates() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns Digital Media Publisher templates
- getDoctype() - Method in interface com.arbortext.e3ci.CCRuleSet
-
Returns the name of the doctype family this rule set composes.
- getDoctype() - Method in class com.arbortext.e3ci.RuleSet
- getDoctype() - Method in interface com.arbortext.epic.prdata.PROperation
-
Returns the doctype family that this rule/rule set composes.
- getDoctype() - Method in class com.arbortext.epic.prdata.Rule
-
Returns the doctype family that this rule/rule set composes.
- getDoctype() - Method in class com.arbortext.epic.prdata.RuleSet
-
Returns the doctype family that this rule/rule set composes.
- getDoctypes() - Method in interface com.arbortext.e3ci.CCRule
-
Returns a list of the document types that this rule is capable of composing.
- getDoctypes() - Method in class com.arbortext.e3ci.Rule
-
Returns a list of the document types that this rule is capable of composing.
- getDoctypes() - Method in interface com.arbortext.epic.prdata.PRRule
-
Returns the doctypes of documents that this rule can compose.
- getDoctypes() - Method in class com.arbortext.epic.prdata.Rule
-
Returns the doctypes of documents that this rule can compose.
- getDocumentTypes() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the configured document types
- getDocumentTypes() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the configured document types
- getDtdPath() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns the absolute path to this doctype's DTD file (xxx.dtd) on the E3 server.
- getDtdPath() - Method in class com.arbortext.e3ci.Doctype
-
Returns the absolute path to this doctype's DTD file (xxx.dtd) on the E3 server.
- getDtdPath(String) - Method in class com.arbortext.e3ci.Manager
-
Returns the absolute path to a doctype's DTD file on the PE server.
- getEntryIndex() - Method in class com.arbortext.epic.prdata.RuleFile.DeletionLocation
- getFailureMessage() - Method in class com.arbortext.e3ci.Manager
-
Returns the reason the most recent attempt to retrieve the composition configuration information from E3 failed.
- getFileDetails() - Method in interface com.arbortext.e3ci.CCStylesheet
-
Returns the file details for the stylesheet.
- getFileDetails() - Method in class com.arbortext.e3ci.Stylesheet
-
Returns the file details for the stylesheet.
- getFiles() - Method in interface com.arbortext.e3ci.CCPathEntry
-
Returns an iterator to the files which this directory contains.
- getFiles() - Method in class com.arbortext.e3ci.PathEntry
-
Returns an iterator to the files which this directory contains.
- getFormattedTimestamp() - Method in interface com.arbortext.e3ci.CCFileDetails
-
Returns the last modifiecation timestamp of the file as a string in the ISO date time format: YYYY-MM-DD HH:mm:ss.
- getFormattedTimestamp() - Method in class com.arbortext.e3ci.FileDetails
-
Returns the last modifiecation timestamp of the file as a string in the ISO date time format: YYYY-MM-DD HH:mm:ss.
- getFramesetFiles() - Method in class com.arbortext.e3ci.CompConfigLocal
-
Returns a iterator over the subdirectories with files in the server's frameset path list.
- getFramesetFiles() - Method in class com.arbortext.e3ci.CompConfigRemote
-
Returns a iterator over the subdirectories with files in the server's frameset path list.
- getFramesetFiles() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns a iterator over the subdirectories with files in the server's frameset path list.
- getFramesetInfo(String) - Method in class com.arbortext.e3ci.Manager
-
Returns information about the framesets for a document type
- getFramesetPath() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the directories in the server's frameset path list
- getFramesetPath() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the directories in the server's frameset path list.
- getFramesets() - Method in class com.arbortext.e3ci.DocConfigFile
-
Returns the framesets defined in this DCF.
- getFrameSets() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns the framesets associated with this document type.
- getFrameSets() - Method in class com.arbortext.e3ci.Doctype
-
Returns an iterator to the list of framesets
- getGenerateTaggedPdf() - Method in interface com.arbortext.e3ci.CCStylesheet
-
Indicates whether this stylesheet generates tagged PDF.
- getGenerateTaggedPdf() - Method in class com.arbortext.e3ci.Stylesheet
-
Indicates whether this stylesheet generates tagged PDF.
- getHostType() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates the type of host on which the E3 server is running.
- getHostType() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates the type of host on which the E3 server is running.
- getHtmlConfig() - Method in class com.arbortext.e3ci.Manager
-
Returns a string containing an HTML page that either describes our configuration or explains why we have no configuration.
- getIdentifier() - Method in class com.arbortext.e3ci.ParsedPI
-
Returns the identifier from the PI element.
- getIgnored() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Indicates whether we're ignored due to a duplicate UUID, parse error, etc.
- getIgnored() - Method in interface com.arbortext.epic.prdata.PRRuleFileEntry
-
Indicates whether this entry should be ignored for processing; it won't be deleted if the rule file is rewritten, but it won't be used in any way.
- getIgnored() - Method in class com.arbortext.epic.prdata.RuleFile
-
Indicates whether we're ignored due to a parse error, duplicate UUID, etc.
- getIgnored() - Method in class com.arbortext.epic.prdata.RuleFileEntry
-
Indicates whether this entry should be ignored for processing; it won't be deleted if the rule file is rewritten, but it won't be used in any way.
- getImportMapInfo() - Method in class com.arbortext.e3ci.Manager
-
Returns information about the import maps installed on the E3 server.
- getImportTemplates() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the import templates defined on the E3 server.
- getImportTemplates() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the import templates defined on the E3 server.
- getIndex() - Method in class com.arbortext.epic.prdata.Operation.ParameterWithIndex
- getInfo() - Method in interface com.arbortext.e3ci.CCStylesheet
-
Returns an assocative array of stylesheet information.
- getInfo() - Method in class com.arbortext.e3ci.Stylesheet
-
Returns an associative array of data as returned by stylesheet_..._get_info() in main::_sslist.acl.
- getInstallationPath() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the absolute path to the PE install tree on the server.
- getInstallationPath() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the absolute path to the PE install tree on the server.
- getInstallationPath() - Method in class com.arbortext.e3ci.Manager
-
Returns the absolute path to the PE install tree on the server.
- getInstallDir() - Method in class com.arbortext.epic.prdata.Author
-
Returns the absolute path of the install tree of the program that created the rule file.
- getInstallDir() - Method in class com.arbortext.epic.prdata.AuthorInstalledApplication
-
Returns the absolute path to the application install tree.
- getInstallDir() - Method in interface com.arbortext.epic.prdata.PRAuthorInstalledApplication
-
Returns the absolute path to the application install tree.
- getInstallPath() - Method in class com.arbortext.epic.prdata.Author
-
Returns the location of the installation tree of the program that created a rule file.
- getInstallPath() - Method in interface com.arbortext.epic.prdata.PRAuthor
-
Returns the location of the installation tree of the program that created a rule file.
- getIsVirtual() - Method in class com.arbortext.epic.prdata.RuleFile
-
Indicates whether we're an internal-use in-memory rule file.
- getIsVirtual() - Method in class com.arbortext.epic.prdata.RuleFileEntry
-
Indicates whether this entry is a temporary wrapper for a single rule (so that f=convert can always execute a rule set).
- getKey() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Returns a unique ID.
- getKey() - Method in interface com.arbortext.epic.prdata.PRRuleFileEntry
-
Returns a unique integer identifying this entry.
- getKey() - Method in class com.arbortext.epic.prdata.RuleFile
-
Returns a unique ID.
- getKey() - Method in class com.arbortext.epic.prdata.RuleFileEntry
-
Returns a unique integer identifying this rule.
- getLabel() - Method in class com.arbortext.e3ci.AppConfigFile
- getLabel() - Method in interface com.arbortext.e3ci.CCAppConfigFile
-
Returns the display name for the config file.
- getLabel() - Method in interface com.arbortext.e3ci.CCCompositionParameter
-
Returns the parameter label.
- getLabel() - Method in interface com.arbortext.e3ci.CCDmpTemplate
-
Returns a descriptive label, suitable for use in GUIs, for the template.
- getLabel() - Method in interface com.arbortext.e3ci.CCOperationType
-
Returns this operation's user-friendly name for use in the GUI.
- getLabel() - Method in interface com.arbortext.e3ci.CCStylesheet
-
Returns stylesheet label for inclusion in Epic composition dialogs
- getLabel() - Method in class com.arbortext.e3ci.CompositionParameter
-
Returns the parameter label.
- getLabel() - Method in class com.arbortext.e3ci.DmpTemplate
-
Returns a descriptive label, suitable for use in GUIs, for the template.
- getLabel() - Method in class com.arbortext.e3ci.OperationType
-
Returns a user-friendly name for this operation.
- getLabel() - Method in class com.arbortext.e3ci.Stylesheet
-
Accessor for stylesheet label
- getLabel() - Method in class com.arbortext.epic.prdata.OperationType
-
Returns a user-friendly type name for use in the GUI.
- getLabel() - Method in interface com.arbortext.epic.prdata.PROperationType
-
Returns a user-friendly label for this operation type.
- getLabels() - Method in class com.arbortext.e3ci.Manager.AcfResult
- getLabels() - Method in class com.arbortext.e3ci.Manager.DtiResult
- getLabels() - Method in class com.arbortext.e3ci.Manager.GsiResult
- getLocation() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Indicates whether this Rule File is defined on the local machine or a PE server.
- getLocation() - Method in class com.arbortext.epic.prdata.RuleFile
-
Indicates whether this Rule File is defined on the local machine or a PE server.
- getManager() - Static method in class com.arbortext.e3ci.Manager
-
Returns a pointer to our instance
- getMd5() - Method in interface com.arbortext.e3ci.CCFileDetails
-
Return the md5 value of the file.
- getMd5() - Method in class com.arbortext.e3ci.FileDetails
-
Return the md5 value of the file.
- getMember(int) - Method in interface com.arbortext.epic.prdata.PRRuleSet
-
Returns a member rule specified by index.
- getMember(int) - Method in class com.arbortext.epic.prdata.RuleSet
-
Returns a member rule specified by index.
- getMemberCount() - Method in interface com.arbortext.epic.prdata.PRRuleSet
-
Returns the number of member rules in this rule set.
- getMemberCount() - Method in class com.arbortext.epic.prdata.RuleSet
-
Returns the number of member rules in this rule set.
- getMemberCount(int) - Method in class com.arbortext.epic.prdata.Database
-
Returns the number of rules in a rule set.
- getMemberIndex(Rule) - Method in class com.arbortext.epic.prdata.RuleSet
-
Gets the index of a member rule in this rule set.
- getMemberKey(int, int) - Method in class com.arbortext.epic.prdata.Database
-
Returns the unique key of a member in a rule set
- getMemberOverrides(int, int) - Method in class com.arbortext.epic.prdata.Database
-
Returns a string-encoded associative array of parameter overrides for a publishing rule in a rule set.
- getMemberReference(int, int) - Method in class com.arbortext.epic.prdata.Database
-
Returns information about a ruleset reference to a member rule.
- getMemberRules() - Method in interface com.arbortext.e3ci.CCRuleSet
-
Returns the rules that this rule set contains.
- getMemberRules() - Method in class com.arbortext.e3ci.RuleSet
-
Returns the rules that this rule set contains.
- getMembers() - Method in interface com.arbortext.epic.prdata.PRRuleSet
-
Returns the rules that this rule set contains.
- getMembers() - Method in class com.arbortext.epic.prdata.RuleSet
-
Returns the rules that this rule set contains.
- getMessages() - Method in class com.arbortext.epic.prdata.MessageHolder
-
Returns our messages.
- getModificationTime() - Method in class com.arbortext.epic.prdata.Author
-
Returns the time a rule file was created or modified.
- getModificationTime() - Method in interface com.arbortext.epic.prdata.PRAuthor
-
Returns the time a rule file was created or modified.
- getModifier() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Returns a descriptor for the program that most recently modified this rule file.
- getModifier() - Method in class com.arbortext.epic.prdata.RuleFile
-
Returns a descriptor for the program that most recently modified this rule file.
- getName() - Method in class com.arbortext.e3ci.AppConfigFile
- getName() - Method in interface com.arbortext.e3ci.CCAppConfigFile
-
Returns the filename for the config file.
- getName() - Method in interface com.arbortext.e3ci.CCApplication
-
Returns the name of this packaged application.
- getName() - Method in interface com.arbortext.e3ci.CCCompositionParameter
-
Returns the parameter name.
- getName() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns the name of the doctype.
- getName() - Method in interface com.arbortext.e3ci.CCFileDetails
-
Return the filename (no path).
- getName() - Method in interface com.arbortext.e3ci.CCImportTemplate
-
Returns File name of the template file on the E3 server.
- getName() - Method in interface com.arbortext.e3ci.CCOperationType
-
Returns this operation's name.
- getName() - Method in interface com.arbortext.e3ci.CCRule
-
Returns this rule's name.
- getName() - Method in interface com.arbortext.e3ci.CCRuleSet
-
Returns this rule set's name.
- getName() - Method in interface com.arbortext.e3ci.CCRuleSet.MemberRule
-
Returns the name of this member rule.
- getName() - Method in interface com.arbortext.e3ci.CCStylesheet
-
Returns filename (last component of path) of stylesheet on E3 server.
- getName() - Method in class com.arbortext.e3ci.CompositionParameter
-
Returns the parameter name.
- getName() - Method in class com.arbortext.e3ci.Doctype
-
Returns the name of the doctype.
- getName() - Method in class com.arbortext.e3ci.FileDetails
-
Return the filename (no path).
- getName() - Method in class com.arbortext.e3ci.ImportTemplate
-
Returns File name of the template file on the E3 server.
- getName() - Method in class com.arbortext.e3ci.OperationType
-
Returns this operation's name.
- getName() - Method in class com.arbortext.e3ci.PackagedApplication
-
Returns the name of this packaged application.
- getName() - Method in class com.arbortext.e3ci.Rule
-
Returns this rule's name.
- getName() - Method in class com.arbortext.e3ci.RuleSet
-
Returns this rule set's name.
- getName() - Method in class com.arbortext.e3ci.Stylesheet
-
Accessor for stylesheet name
- getName() - Method in class com.arbortext.epic.prdata.Author
-
Returns the name of the program that created a rule file.
- getName() - Method in class com.arbortext.epic.prdata.AuthorInstalledApplication
-
Returns the absolute path to the application install tree.
- getName() - Method in class com.arbortext.epic.prdata.Doctype
-
Returns the name of this doctype.
- getName() - Method in class com.arbortext.epic.prdata.Parameter
-
Returns our name.
- getName() - Method in interface com.arbortext.epic.prdata.PRAuthor
-
Returns the name of the program that created a rule file.
- getName() - Method in interface com.arbortext.epic.prdata.PRAuthorInstalledApplication
-
Returns the application name.
- getName() - Method in interface com.arbortext.epic.prdata.PRDoctype
-
Returns the document type's name.
- getName() - Method in interface com.arbortext.epic.prdata.PRParameter
-
Returns the parameter name.
- getName() - Method in interface com.arbortext.epic.prdata.PRRuleFileEntry
-
Returns the name of this rule.
- getName() - Method in interface com.arbortext.epic.prdata.PRSetMember
-
Returns the name of the rule we reference.
- getName() - Method in class com.arbortext.epic.prdata.RuleFileEntry
-
Returns the name of this rule.
- getName() - Method in class com.arbortext.epic.prdata.SetMember
- getNames() - Method in class com.arbortext.e3ci.Manager.AcfResult
- getNames() - Method in class com.arbortext.e3ci.Manager.AcvResult
- getNames() - Method in class com.arbortext.e3ci.Manager.FsiResult
- getNames() - Method in class com.arbortext.e3ci.Manager.GaiResult
- getNames() - Method in class com.arbortext.e3ci.Manager.GsiResult
- getNewParameters() - Method in class com.arbortext.epic.prdata.Database
-
Returns the parameters associated with a rule that's in the process of being created.
- getOperation() - Method in interface com.arbortext.e3ci.CCRule
-
Returns the name of the operation that this rule represents.
- getOperation() - Method in class com.arbortext.e3ci.Rule
-
Returns the name of the operation that this rule represents.
- getOperationData(int) - Method in class com.arbortext.epic.prdata.Database
-
Returns information about a publishing operation as elements in an associative array.
- getOperationKeys() - Method in class com.arbortext.epic.prdata.Database
-
Returns all known operations.
- getOperationKeys(String, boolean) - Method in class com.arbortext.epic.prdata.Database
-
Returns the operations (rules and rule sets) that can compose a given doctype on either the client or a PE server.
- getOperationType() - Method in interface com.arbortext.epic.prdata.PRRule
-
Returns the composition operation type, expressed as a string.
- getOperationType() - Method in class com.arbortext.epic.prdata.Rule
-
Returns the composition operation type
- getOperationTypes() - Method in interface com.arbortext.e3ci.CCRuleFile
-
Returns a list of the composition operation types defined in this rule file.
- getOperationTypes() - Method in class com.arbortext.e3ci.RuleFile
-
Returns a list of the composition operation types defined in this rule file.
- getOs() - Method in class com.arbortext.e3ci.Manager.AcvResult
- getOsName() - Method in class com.arbortext.e3ci.ApplicationClientVersion
-
Returns the name of the OS supported.
- getOsName() - Method in interface com.arbortext.e3ci.CCApplicationClientVersion
-
Returns the name of the OS supported.
- getOutputParameterName() - Method in interface com.arbortext.e3ci.CCOperationType
-
Returns the name of the composition parameter that specifies where to write the output file or directory.
- getOutputParameterName() - Method in class com.arbortext.e3ci.OperationType
-
Returns the name of the composition parameter that specifies where to write the output file or directory.
- getOutputParameterName() - Method in class com.arbortext.epic.prdata.OperationType
-
Returns the name of the ACL composition parameter array entry that specifies the absolute path to the output file or directory for this composition type.
- getOutputParameterName() - Method in interface com.arbortext.epic.prdata.PROperationType
-
Returns the name of the ACL composition parameter array entry that specifies the absolute path to the output file or directory for this composition type.
- getOutputPatternLabel() - Method in interface com.arbortext.e3ci.CCOperationType
-
Returns a user-friendly string stating what kind of file is being browsed for in a browse-for-output-file dialog.
- getOutputPatternLabel() - Method in class com.arbortext.e3ci.OperationType
-
Returns a user-friendly string stating what kind of file is being browsed for in a browse-for-output-file dialog.
- getOutputPatternLabel() - Method in class com.arbortext.epic.prdata.OperationType
-
Returns a label suitable for telling the user what kind of output file should be selected in a browse-for-output-file dialog.
- getOutputPatternLabel() - Method in interface com.arbortext.epic.prdata.PROperationType
-
Returns a label suitable for telling the user what kind of output file should be selected in a browse-for-output-file dialog.
- getOutputType() - Method in interface com.arbortext.e3ci.CCOperationType
-
Returns the kind of output this operation produces.
- getOutputType() - Method in class com.arbortext.e3ci.OperationType
-
Returns the kind of output this operation produces.
- getOutputType() - Method in class com.arbortext.epic.prdata.OperationType
-
Returns the kind of output that an operation of this type produces.
- getOutputType() - Method in interface com.arbortext.epic.prdata.PROperationType
-
Returns the kind of output that an operation of this type produces.
- getPackage() - Method in interface com.arbortext.e3ci.CCOperationType
-
Returns the name of the ACL package that implements this operation.
- getPackage() - Method in class com.arbortext.e3ci.OperationType
-
Returns the name of the ACL package that implements this operation.
- getPackage() - Method in class com.arbortext.epic.prdata.OperationType
-
Returns the name of the ACL package used to produce this type of output.
- getPackage() - Method in interface com.arbortext.epic.prdata.PROperationType
-
Returns the name of the ACL package used to produce this type of output.
- getParameter() - Method in class com.arbortext.epic.prdata.Operation.ParameterWithIndex
- getParameters() - Method in interface com.arbortext.e3ci.CCComposer
-
Returns the composer's parameters
- getParameters() - Method in interface com.arbortext.e3ci.CCDocumentComposer
-
Returns map of parameters.
- getParameters() - Method in interface com.arbortext.e3ci.CCRule
-
Returns this rule's parameters.
- getParameters() - Method in interface com.arbortext.e3ci.CCRuleSet
-
Returns this rule set's parameters.
- getParameters() - Method in class com.arbortext.e3ci.Composer
-
Returns iterator for all parameters
- getParameters() - Method in class com.arbortext.e3ci.DocumentComposer
-
Accessor for composer parameter overrides
- getParameters() - Method in class com.arbortext.e3ci.Rule
-
Returns this rule's parameters.
- getParameters() - Method in class com.arbortext.e3ci.RuleSet
-
Returns this rule set's parameters.
- getParameters() - Method in class com.arbortext.epic.prdata.Operation
-
Returns the parameters that govern the execution of this operation.
- getParameters() - Method in interface com.arbortext.epic.prdata.PROperation
-
Returns the parameters that govern the execution of this operation.
- getPath() - Method in class com.arbortext.e3ci.AppConfigFile
-
Returns an absolute path to the config file on the PE server.
- getPath() - Method in interface com.arbortext.e3ci.CCAppConfigFile
-
Returns an absolute path to the config file on the PE server.
- getPath() - Method in interface com.arbortext.e3ci.CCComposer
-
Returns absolute pathname of .ccf file on E3 server
- getPath() - Method in interface com.arbortext.e3ci.CCDmpTemplate
-
Returns the absolute path to the template directory on the PE server.
- getPath() - Method in interface com.arbortext.e3ci.CCDocumentComposer
-
Returns absolute pathname of .ccf file on E3 server
- getPath() - Method in interface com.arbortext.e3ci.CCFileDetails
-
Returns the path and filename of the file.
- getPath() - Method in interface com.arbortext.e3ci.CCFrameset
-
Returns absolute path to frameset directory on E3 server
- getPath() - Method in interface com.arbortext.e3ci.CCImportTemplate
-
Returns absolute path to template file on the E3 server.
- getPath() - Method in interface com.arbortext.e3ci.CCPathEntry
-
Returns the absolute path to this directory on the server.
- getPath() - Method in interface com.arbortext.e3ci.CCRuleFile
-
Returns the absolute path to this rule file on the PE server.
- getPath() - Method in interface com.arbortext.e3ci.CCStylesheet
-
Returns absolute path to stylesheet on E3 server.
- getPath() - Method in class com.arbortext.e3ci.Composer
-
Accessor for stylesheet path
- getPath() - Method in class com.arbortext.e3ci.DmpTemplate
-
Returns the absolute path to the template directory on the PE server.
- getPath() - Method in class com.arbortext.e3ci.DocumentComposer
-
Accessor for stylesheet path
- getPath() - Method in class com.arbortext.e3ci.FileDetails
-
Returns the path and filename of the file.
- getPath() - Method in class com.arbortext.e3ci.Frameset
-
Accessor for stylesheet path
- getPath() - Method in class com.arbortext.e3ci.ImportTemplate
-
Returns absolute path to template file on the E3 server.
- getPath() - Method in class com.arbortext.e3ci.PathEntry
-
Returns the absolute path to this directory on the server.
- getPath() - Method in class com.arbortext.e3ci.RuleFile
-
Returns the absolute path to this rule file on the PE server.
- getPath() - Method in class com.arbortext.e3ci.Stylesheet
-
Accessor for stylesheet path
- getPath() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Returns the absolute path to this Rule File.
- getPath() - Method in class com.arbortext.epic.prdata.RuleFile
-
Returns the absolute path to this Rule File.
- getPaths() - Method in class com.arbortext.e3ci.Manager.AcfResult
- getPaths() - Method in class com.arbortext.e3ci.Manager.DtiResult
- getPaths() - Method in class com.arbortext.e3ci.Manager.FsiResult
- getPaths() - Method in class com.arbortext.e3ci.Manager.GsiResult
- getPaths() - Method in class com.arbortext.e3ci.Manager.ImResult
- getPdfConfigCount() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the number of PDF configuration files installed on the server.
- getPdfConfigCount() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the number of PDF configuration files installed on the server.
- getPdfConfigFiles() - Method in class com.arbortext.e3ci.CompConfig
-
Returns a list of PDF configuration files installed on the server.
- getPdfConfigFiles() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns a list of PDF configuration files installed on the server.
- getPdfConfigFiles() - Method in class com.arbortext.e3ci.Manager
-
Returns the PDF config files installed on the PE server.
- getPotentialMembers(int) - Method in class com.arbortext.epic.prdata.Database
-
Returns the keys of all rules that could be added to the set.
- getPrintEngine() - Method in interface com.arbortext.e3ci.CCStylesheet
-
Returns this stylesheet's preferred print engine.
- getPrintEngine() - Method in class com.arbortext.e3ci.Stylesheet
-
Returns this stylesheet's preferred print engine.
- getPrintEngineDefault() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the value of the server's 'printenginedefault' option.
- getPrintEngineDefault() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the value of the server's 'printenginedefault' option.
- getPrintEngineDefault() - Method in class com.arbortext.e3ci.Manager
-
Returns the PE Server's 'printenginedefault' flag
- getPrintEngines() - Method in class com.arbortext.e3ci.Manager.GsiResult
- getProgramName() - Method in class com.arbortext.e3ci.ApplicationClientVersion
-
Returns the name of the program supported.
- getProgramName() - Method in interface com.arbortext.e3ci.CCApplicationClientVersion
-
Returns the name of the program supported.
- getPublicIds() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns the public IDs associated with this document type.
- getPublicIds() - Method in class com.arbortext.e3ci.Doctype
-
Returns an iterator over the list of public IDs
- getRegistrationMarks() - Method in class com.arbortext.e3ci.AppConfigFile
-
Returns the registrationMarks attribute.
- getRegistrationMarks() - Method in interface com.arbortext.e3ci.CCAppConfigFile
-
Returns the registrationMarks attribute.
- getRegMarks() - Method in class com.arbortext.e3ci.Manager.AcfResult
- getRequired() - Method in interface com.arbortext.e3ci.CCCompositionParameter
-
Indicates whether this parameter is required by the composer.
- getRequired() - Method in class com.arbortext.e3ci.CompositionParameter
-
Indicates whether this parameter is required by the composer.
- getRuleFile() - Method in interface com.arbortext.epic.prdata.PRRuleFileEntry
-
Returns a reference to the Rule File in which this object is defined.
- getRuleFile() - Method in class com.arbortext.epic.prdata.RuleFileEntry
-
Returns a reference to the Rule File in which this object is defined.
- getRuleFileData(int) - Method in class com.arbortext.epic.prdata.Database
-
Returns information about a rule file
- getRuleFileKeys(boolean) - Method in class com.arbortext.epic.prdata.Database
-
Returns the UUID of every known and valid rule file.
- getRuleFilePaths() - Method in class com.arbortext.epic.prdata.Database
-
Returns a list of the directories in which we look for rule files.
- getRuleFiles() - Method in class com.arbortext.e3ci.CompConfig
-
Returns a list of publishing rule files defined on the server.
- getRuleFiles() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the publishing rule files defined on the PE server.
- getRuleFiles(boolean) - Method in class com.arbortext.epic.prdata.Database
-
Returns a list of all known rule files.
- getRuleFiles(boolean) - Method in interface com.arbortext.epic.prdata.PRDatabase
-
Returns a list of all known rule files.
- getRuleFileUuid() - Method in interface com.arbortext.e3ci.CCRuleSet.MemberRule
-
Returns the UUID of the rule file in which this member rule is defined.
- getRules() - Method in interface com.arbortext.e3ci.CCRuleFile
-
Returns a list of the rules defined in this rule file.
- getRules() - Method in class com.arbortext.e3ci.RuleFile
-
Returns a list of the rules defined in this rule file.
- getRules() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Returns a list containing all of the publishing rules in this rule file.
- getRules() - Method in class com.arbortext.epic.prdata.RuleFile
-
Returns a list containing all of the rules in this rule file.
- getRuleSets() - Method in interface com.arbortext.e3ci.CCRuleFile
-
Returns a list of the rule sets defined in this rule file.
- getRuleSets() - Method in class com.arbortext.e3ci.RuleFile
-
Returns a list of the rule sets defined in this rule file.
- getRuleSets() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Returns a list containing all of the publishing rule sets in this rule file.
- getRuleSets() - Method in class com.arbortext.epic.prdata.RuleFile
-
Returns a list containing all of the rule sets in this rule file.
- getServerBuildDate() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the build date for the E3 server
- getServerBuildDate() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the build date for the E3 server
- getServerBuildDate() - Method in class com.arbortext.e3ci.Manager
-
Returns the build date of the E3 Request Manager (E3 Server)
- getServerBuildName() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the build name for the E3 server
- getServerBuildName() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the build name for the E3 server
- getServerBuildName() - Method in class com.arbortext.e3ci.Manager
-
Returns the build name of the E3 Request Manager (E3 Server)
- getServerHostType() - Method in class com.arbortext.e3ci.Manager
-
Returns the server's host type.
- getServerParameter(String) - Method in class com.arbortext.e3ci.CompConfig
-
Get PE server global parameter
- getServerParameter(String) - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Get PE server global parameter
- getServerParameter(String) - Method in class com.arbortext.e3ci.Manager
-
Get PE server global parameter
- getServerPathSeparator() - Method in class com.arbortext.e3ci.Manager
-
Returns the path separator character ( "/" or "\") appropriate to the E3 server machine
- getServerVersion() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the version for the E3 server
- getServerVersion() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the version for the E3 server
- getServerVersion() - Method in class com.arbortext.e3ci.Manager
-
Returns the version of the E3 Request Manager (E3 Server)
- getSpecificIndex() - Method in class com.arbortext.epic.prdata.RuleFile.DeletionLocation
- getStatus() - Method in class com.arbortext.e3ci.Manager
-
Returns our status in a format suitable for display
- getStylesheetData(String, String) - Method in class com.arbortext.e3ci.Manager
-
Returns a stylesheet's information array, as returned by main::stylesheet_..._get_info() on _sslist.acl on the server.
- getStylesheetGenerateTaggedPdf(String) - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns a stylesheet's Generate Tagged PDF flag
- getStylesheetGenerateTaggedPdf(String) - Method in class com.arbortext.e3ci.Doctype
-
Returns a stylesheet's Generate Tagged PDF flag
- getStylesheetGenerateTaggedPdf(String, String) - Method in class com.arbortext.e3ci.Manager
-
Returns a stylesheet's GenerateTaggedPDF flag
- getStylesheetInfo(String, String, int) - Method in class com.arbortext.e3ci.Manager
-
Returns information about selected stylesheets for a document
- getStylesheetLabel(String, String) - Method in class com.arbortext.e3ci.Manager
-
Returns a stylesheet label.
- getStylesheetName(String) - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns the name of a stylesheet.
- getStylesheetName(String) - Method in class com.arbortext.e3ci.Doctype
-
Returns the name of a stylesheet (last component in path, which might use a different separator than on the current machine)
- getStylesheetName(String, String) - Method in class com.arbortext.e3ci.Manager
-
Returns the name of a stylesheet, given an absolute path.
- getStylesheetOrdering(String) - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns an iterator over a list of
Stringstylesheet names. - getStylesheetOrdering(String) - Method in class com.arbortext.e3ci.Doctype
-
Returns an iterator over a list of
Stringstylesheet names. - getStylesheetOrderings() - Method in class com.arbortext.e3ci.DocConfigFile
-
Returns the list of stylesheet orderings
- getStylesheetOrderingUses() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns an iterator over a list of use codes, one for each stylesheet ordering defined.
- getStylesheetOrderingUses() - Method in class com.arbortext.e3ci.Doctype
-
Returns an iterator over a list of use codes, one for each stylesheet ordering defined.
- getStylesheetPath(String) - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns the absolute path to a stylesheet.
- getStylesheetPath(String) - Method in class com.arbortext.e3ci.Doctype
-
Returns the absolute path to a stylesheet.
- getStylesheetPath(String, String) - Method in class com.arbortext.e3ci.Manager
-
Returns the absolute path to a stylesheet, given its name.
- getStylesheetPrintEngine(String) - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns a stylesheet's print engine
- getStylesheetPrintEngine(String) - Method in class com.arbortext.e3ci.Doctype
-
Returns a stylesheet's print engine
- getStylesheetPrintEngine(String, String) - Method in class com.arbortext.e3ci.Manager
-
Returns a stylesheet's print engine, given its name.
- getStyleSheets() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns an iterator to the list of style sheets associated with this document type.
- getStyleSheets() - Method in class com.arbortext.e3ci.Doctype
-
Returns an iterator to the list of stylesheets
- getSubprocessBuildDate() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the build date for the E3 subprocess
- getSubprocessBuildDate() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the build date for the E3 subprocess
- getSubprocessBuildDate() - Method in class com.arbortext.e3ci.Manager
-
Returns the build date of the E3 Subprocess.
- getSubprocessBuildName() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the build name for the E3 subprocess
- getSubprocessBuildName() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the build name for the E3 subprocess
- getSubprocessBuildName() - Method in class com.arbortext.e3ci.Manager
-
Returns the build name of the E3 Subprocess.
- getSubprocessVersion() - Method in class com.arbortext.e3ci.CompConfig
-
Returns the version for the E3 subprocess
- getSubprocessVersion() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Returns the version for the E3 subprocess
- getSubprocessVersion() - Method in class com.arbortext.e3ci.Manager
-
Returns the version of the E3 Subprocess.
- getSuffix() - Method in interface com.arbortext.e3ci.CCOperationType
-
Returns the default suffix of the output file produced by this operation.
- getSuffix() - Method in class com.arbortext.e3ci.OperationType
-
Returns the default suffix of the output file produced by this operation.
- getSuffix() - Method in class com.arbortext.epic.prdata.OperationType
-
Returns the suffix ("pdf", "xml", "htm") for the output file that this composition type produces.
- getSuffix() - Method in interface com.arbortext.epic.prdata.PROperationType
-
Returns the suffix ("pdf", "xml", "htm") for the output file that this composition type produces.
- getSystemId() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns our system ID.
- getSystemId() - Method in class com.arbortext.e3ci.Doctype
-
Returns the doctype's system ID
- getSystemIdMappings() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns an iterator over the system IDs mapped to this doctype
- getSystemIdMappings() - Method in class com.arbortext.e3ci.Doctype
-
Returns an iterator over the system IDs mapped to this doctype
- getTagging() - Method in class com.arbortext.e3ci.AppConfigFile
-
Returns the tagging attribute (for tagged PDF).
- getTagging() - Method in interface com.arbortext.e3ci.CCAppConfigFile
-
Returns the tagging attribute (for tagged PDF).
- getTagging() - Method in class com.arbortext.e3ci.Manager.AcfResult
- getTarget() - Method in class com.arbortext.epic.prdata.Operation
-
Returns a location code indicating whether this rule describes a composition operation on the PE server or the local machine.
- getTarget() - Method in interface com.arbortext.epic.prdata.PROperation
-
Returns a location code indicating whether this rule describes a composition operation on the PE server or the local machine.
- getTimestamp() - Method in interface com.arbortext.e3ci.CCFileDetails
-
Returns the last modification timestamp of the file.
- getTimestamp() - Method in class com.arbortext.e3ci.FileDetails
-
Returns the last modification timestamp of the file.
- getTurbos() - Method in class com.arbortext.e3ci.Manager.GsiResult
- getType() - Method in class com.arbortext.e3ci.AppConfigFile
-
Returns the configuration file type.
- getType() - Method in interface com.arbortext.e3ci.CCAppConfigFile
-
Returns the configuration file type.
- getType() - Method in interface com.arbortext.e3ci.CCCompositionParameter
-
Returns the parameter type, if any was specified.
- getType() - Method in interface com.arbortext.e3ci.CCDocumentComposer
-
Returns types of composition supported by this composer
- getType() - Method in interface com.arbortext.e3ci.CCFrameset
-
Returns the frameset type
- getType() - Method in class com.arbortext.e3ci.CompositionParameter
-
Returns the parameter type, if any was specified.
- getType() - Method in class com.arbortext.e3ci.DocumentComposer
-
Accessor for composer type
- getType() - Method in class com.arbortext.e3ci.Frameset
-
Accessor for frameset type
- getTypeData(String) - Method in class com.arbortext.epic.prdata.Database
-
Returns information about a type as an associative array.
- getTypeDataForKey(int) - Method in class com.arbortext.epic.prdata.Database
-
Returns information about a type as an associative array.
- getTypeKeys() - Method in class com.arbortext.epic.prdata.Database
-
Returns a list containing the unique identifier of every known composition operation.
- getTypes() - Method in class com.arbortext.e3ci.Manager.AcfResult
- getTypes() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Returns a list containing all of the composition types in this rule file.
- getTypes() - Method in class com.arbortext.epic.prdata.RuleFile
-
Returns a list containing all of the composition types defined in this rule file.
- getUris() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns an iterator over the doctype's list of URIs
- getUris() - Method in class com.arbortext.e3ci.Doctype
-
Returns an iterator over the doctype's list of URIs
- getUseArray() - Method in interface com.arbortext.e3ci.CCStylesheet
-
Returns array of supported composition types
- getUseArray() - Method in class com.arbortext.e3ci.Stylesheet
-
Accessor for stylesheet use array
- getUses() - Method in interface com.arbortext.e3ci.CCStylesheet
-
Returns comma-separated list of composition types
- getUses() - Method in class com.arbortext.e3ci.Stylesheet
-
Accessor for stylesheet uses
- getUuid() - Method in interface com.arbortext.e3ci.CCRuleFile
-
Returns this rule file's universal unique identifier.
- getUuid() - Method in class com.arbortext.e3ci.RuleFile
-
Returns this rule file's universal unique identifier.
- getUuid() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Returns this rule file's unique ID.
- getUuid() - Method in interface com.arbortext.epic.prdata.PRSetMember
-
Returns the UUID identifying the rule file containing this rule.
- getUuid() - Method in class com.arbortext.epic.prdata.RuleFile
-
Returns this rule file's unique ID.
- getUuid() - Method in class com.arbortext.epic.prdata.SetMember
- getValue() - Method in class com.arbortext.epic.prdata.Parameter
-
Returns our value.
- getValue() - Method in interface com.arbortext.epic.prdata.PRParameter
-
Returns the parameter value.
- getValue(String) - Method in class com.arbortext.e3ci.ParsedPI
-
Returns the values from a keyword/value pair
- getValueList() - Method in interface com.arbortext.e3ci.CCCompositionParameter
-
Returns a list of all legal values for an enumeration-type parameter.
- getValueList() - Method in class com.arbortext.e3ci.CompositionParameter
-
Returns a list of all legal values for an enumeration-type parameter.
- getVendor() - Method in interface com.arbortext.e3ci.CCApplication
-
Returns the vendor of this packaged application.
- getVendor() - Method in class com.arbortext.e3ci.PackagedApplication
-
Returns the vendor of this packaged application.
- getVendors() - Method in class com.arbortext.e3ci.Manager.GaiResult
- getVersion() - Method in class com.arbortext.e3ci.ApplicationClientVersion
-
Returns the version number of the application on the client.
- getVersion() - Method in interface com.arbortext.e3ci.CCApplication
-
Returns the version of this packaged application.
- getVersion() - Method in interface com.arbortext.e3ci.CCApplicationClientVersion
-
Returns the version number of the application on the client.
- getVersion() - Method in class com.arbortext.e3ci.PackagedApplication
-
Returns the version of this packaged application.
- getVersion() - Method in class com.arbortext.epic.prdata.Author
-
Returns the version of a program that created a rule file.
- getVersion() - Method in class com.arbortext.epic.prdata.AuthorInstalledApplication
-
Returns the application name.
- getVersion() - Method in interface com.arbortext.epic.prdata.PRAuthor
-
Returns the version of a program that created a rule file.
- getVersion() - Method in interface com.arbortext.epic.prdata.PRAuthorInstalledApplication
-
Returns the version of the application that was installed.
- getVersions() - Method in class com.arbortext.e3ci.Manager.AcvResult
- getVersions() - Method in class com.arbortext.e3ci.Manager.GaiResult
- getWritableDirectories() - Method in class com.arbortext.epic.prdata.Database
-
Returns a list of directory paths in which rule file creation is likely to succeed.
- getXsdPath() - Method in interface com.arbortext.e3ci.CCDoctype
-
Returns the absolute path to this doctype's schema file (xxx.xsd) on the E3 server.
- getXsdPath() - Method in class com.arbortext.e3ci.Doctype
-
Returns the absolute path to this doctype's schema file (xxx.xsd) on the E3 server.
- getXsdPath(String) - Method in class com.arbortext.e3ci.Manager
-
Returns the absolute path to a doctype's XSD file on the PE server.
- GsiResult() - Constructor for class com.arbortext.e3ci.Manager.GsiResult
- GsiResult(int, String[], String[], String[], String[], Boolean[]) - Constructor for class com.arbortext.e3ci.Manager.GsiResult
H
- hashCode() - Method in class com.arbortext.e3ci.FileDetails
-
Returns a unique integer for this object.
- hashCode() - Method in class com.arbortext.e3ci.PackagedApplication
-
Returns a hashcode uniquely identifying this object.
- hasModifications() - Method in class com.arbortext.epic.prdata.RuleFile
-
Indicates whether modifications have been made to the operations in this rule file but not saved to disk.
- hasPublicIds() - Method in class com.arbortext.e3ci.Doctype
-
Indicates whether we have at least one public ID
- HOST_UNIX - Static variable in interface com.arbortext.e3ci.CompositionConfiguration
-
E3 host is a Unix platform
- HOST_UNKNOWN - Static variable in interface com.arbortext.e3ci.CompositionConfiguration
-
Unused: placeholder for unknown host type
- HOST_WINDOWS - Static variable in interface com.arbortext.e3ci.CompositionConfiguration
-
E3 host is a Windows platform
I
- ImportTemplate - Class in com.arbortext.e3ci
-
Describes a single CDOCS import template.
- ImportTemplate(String, String) - Constructor for class com.arbortext.e3ci.ImportTemplate
-
Initializes a new descriptor.
- ImportTemplate(String, String, String, long) - Constructor for class com.arbortext.e3ci.ImportTemplate
-
Initializes a new descriptor with the md5 value.
- ImResult() - Constructor for class com.arbortext.e3ci.Manager.ImResult
- ImResult(int, String[], String[]) - Constructor for class com.arbortext.e3ci.Manager.ImResult
- init(E3ApplicationConfig) - Method in class com.arbortext.e3ci.Application
-
called when this application is loaded
- init(E3ApplicationConfig) - Method in class com.arbortext.e3ci.AppMd5
-
called when this application is loaded
- initialize() - Method in class com.arbortext.e3ci.Manager
-
Called by Epic at launch time to fetch the configuration object for the first time.
- insertMember(SetMember) - Method in class com.arbortext.epic.prdata.RuleSet
-
Adds a member to our list of members.
- insertParameter(Parameter) - Method in class com.arbortext.epic.prdata.Operation
-
Adds a new parameter to the end of our store.
- insertParameterWithIndex(Operation.ParameterWithIndex) - Method in class com.arbortext.epic.prdata.Operation
-
Inserts a parameter into a particular location in our store.
- instead of and tags - Search tag in com.arbortext.e3ci.CompConfigServer.serializeHtml(File, String, String, boolean, boolean)
- Section
- instead of and tags - Search tag in com.arbortext.e3ci.CompositionConfiguration.toStringHtml(String, String, boolean, boolean)
- Section
- isAppInstalled() - Method in class com.arbortext.e3ci.CompConfig
-
Indiates whether APP is installed on the E3 server.
- isAppInstalled() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether APP is installed on the E3 server.
- isAppInstalled() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether APP is installed on the server
- isChangePageLicensed() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether the Change Page Application is licensed to the E3 server.
- isChangePageLicensed() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether the Change Page Application is licensed to the E3 server.
- isChangePageLicensed() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether the Change Page Application is licensed to the E3 server.
- isComposerInstalled(String) - Method in class com.arbortext.e3ci.Manager
-
Indicates whether a given composer is installed on the server
- isContributorLicensed() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether the Epic Contributor is licensed to the E3 server.
- isContributorLicensed() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether the Arbortext Contributor is licensed to the E3 server.
- isContributorLicensed() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether the Arbortext Contributor is licensed to the E3 server.
- isCreator() - Method in class com.arbortext.epic.prdata.Author
-
Indicates whether this object contains information about the creator of a rule file.
- isCreator() - Method in interface com.arbortext.epic.prdata.PRAuthor
-
Indicates whether this object contains information about the creator of a rule file.
- isCreoViewInstalled() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether CreoView is installed on the PE server.
- isCreoViewInstalled() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether CreoView is installed on the PE server.
- isCreoViewInstalled() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether CreoView is installed on the server
- isDataAvailable() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether data is available from the E3 server
- isDistillerInstalled() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether Adobe Acrobat Distiller is installed on the E3 server
- isDistillerInstalled() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether Adobe Acrobat Distiller is installed on the E3 server
- isDistillerInstalled() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether Acrobat Distiller is installed on the server
- isDmpInstalled() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether the Digital Media Publisher (DMP) is installed.
- isDmpInstalled() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether the Digital Media Publisher (DMP) is installed.
- isDmpInstalled() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether DMP is installed on the server
- isDoctypeInstalled(String) - Method in class com.arbortext.e3ci.Manager
-
Indicates whether a given doctype is installed on the server
- isEpubConverterInstalled() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether the EPUB converter is installed on the server.
- isEpubInstalled() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether the epub converter is installed.
- isEpubInstalled() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether the epub converter is installed on the E3 server.
- isEqual(PRAuthor) - Method in class com.arbortext.epic.prdata.Author
-
Indicates whether this object describes the same configuration as another object.
- isEqual(PRAuthor) - Method in interface com.arbortext.epic.prdata.PRAuthor
-
Indicates whether this object describes the same configuration as another object.
- isEqual(PRAuthorInstalledApplication) - Method in class com.arbortext.epic.prdata.AuthorInstalledApplication
-
Indicates whether this object describes the same application as another application descriptor.
- isEqual(PRAuthorInstalledApplication) - Method in interface com.arbortext.epic.prdata.PRAuthorInstalledApplication
-
Indicates whether this object describes the same application as another application descriptor.
- isFramesetInstalled(String) - Method in class com.arbortext.e3ci.Manager
-
Indicates whether at least one frameset is defined for a doctype
- isHtmlHelpCompilerInstalled() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether the HTML Help Compiler is installed on the E3 server
- isHtmlHelpCompilerInstalled() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether the HTML Help Compiler is installed on the E3 server
- isHtmlHelpCompilerInstalled() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether the HTML Help compiler is installed on the server
- isImportExportLicensed() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether the import/export feature is licensed.
- isImportExportLicensed() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether import/export is licensed on the E3 server.
- isImportExportLicensed() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether the import/export feature is licensed to the E3 server.
- isInterchangeLicensed() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether the interchange feature is licensed.
- isInterchangeLicensed() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether interchange is licensed on the E3 server.
- isInterchangeLicensed() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether the interchange feature is licensed to the E3 server.
- isModifiable() - Method in interface com.arbortext.epic.prdata.PRRuleFile
-
Indicates whether this rule file can be modified (i.e., deleted or rewritten to disk).
- isModifiable() - Method in class com.arbortext.epic.prdata.RuleFile
-
Indicates whether this rule file can be modified (i.e., deleted or rewritten to disk).
- isPrintComposerLicensed() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether the Print Composer is licensed to the E3 server.
- isPrintComposerLicensed() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether the Print Composer is licensed to the E3 server.
- isPrintComposerLicensed() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether the Print Composer is licensed to the E3 server.
- isPublicIdDefined(String) - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether a given public ID is defined on the E3 server.
- isPublicIdDefined(String) - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether a given public ID is defined on the E3 server.
- isPublicIdDefined(String) - Method in class com.arbortext.e3ci.Manager
-
Indicates whether a given public ID is defined on the E3 server.
- isStylesheetInstalled(String, String) - Method in class com.arbortext.e3ci.Manager
-
Indicates whether at least one stylesheet is defined for a particular composition type for a doctype
- isStylesheetValidForUse(String, String, String) - Method in class com.arbortext.e3ci.Manager
-
Indicates whether a stylesheet is valid for a particular use
- isTurbo() - Method in interface com.arbortext.e3ci.CCStylesheet
-
Indicates whether this stylesheet could be edited with turbo styler.
- isTurbo() - Method in class com.arbortext.e3ci.Stylesheet
-
Indicates whether this stylesheet could be edited with turbo styler.
- isValidDmpTemplatePath(String) - Method in class com.arbortext.e3ci.Manager
-
Indicates whether a path is a legal DMP template path
- isWebComposerLicensed() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether the Web Composer is licensed to the E3 server.
- isWebComposerLicensed() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether the Web Composer is licensed to the E3 server.
- isWebComposerLicensed() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether the Web Composer is licensed to the E3 server.
L
- loadFromDcf(DocConfigFile) - Method in class com.arbortext.e3ci.Doctype
- loadMembers(List<SetMember>) - Method in class com.arbortext.epic.prdata.RuleSet
-
Replaces our list of members with a new list.
- loadSelectionRuleSet(String[]) - Method in class com.arbortext.epic.prdata.Database
-
Loads a set of rules into the selection rule set.
- LOCAL - Enum constant in enum class com.arbortext.epic.prdata.PRLocation
- logger - Static variable in class com.arbortext.e3ci.CompConfigLocal
-
Logger for tracing execution.
M
- main(String[]) - Static method in class com.arbortext.e3ci.CompConfigRemote
-
Deprecated, for removal: This API element is subject to removal in a future version.Should not have a main method
- main(String[]) - Static method in class com.arbortext.e3ci.Manager
-
Main program for testing.
- Manager - Class in com.arbortext.e3ci
-
Singleton composition configuration manager for an Epic process or E3 subprocess.
- Manager.AcfResult - Class in com.arbortext.e3ci
-
Inner class to hold the result of a call to Manager.getAppConfigFiles for extraction to ACL.
- Manager.AcvResult - Class in com.arbortext.e3ci
-
Inner class to hold the result of a call to Manager.getApplicationClientVersions for extraction to ACL.
- Manager.DtiResult - Class in com.arbortext.e3ci
-
Inner class to hold the result of a call to Manager.getDmpTemplates for extraction to ACL.
- Manager.FsiResult - Class in com.arbortext.e3ci
-
Inner class to hold the result of a call to Manager.getFramesetInfo for extraction to ACL.
- Manager.GaiResult - Class in com.arbortext.e3ci
- Manager.GsiResult - Class in com.arbortext.e3ci
- Manager.ImResult - Class in com.arbortext.e3ci
-
Inner class to hold the result of a call to Manager.getImportMaps for extraction to ACL.
- manifestEndRule(Map<String, String>) - Method in class com.arbortext.epic.prdata.Database
-
Terminate the description of a rule's execution in the rule set manifest.
- manifestEndSet(Map<String, String>) - Method in class com.arbortext.epic.prdata.Database
-
Terminates a manifest file describing the execution of a rule set.
- manifestStartRule(int, Map<String, String>) - Method in class com.arbortext.epic.prdata.Database
-
Starts a manifest file entry describing the execution of a rule.
- manifestStartSet(int, String, boolean, Map<String, String>) - Method in class com.arbortext.epic.prdata.Database
-
Starts a manifest file describing the execution of a rule set.
- MessageHolder - Class in com.arbortext.epic.prdata
-
Abstract base class that manages a list of messages.
- MessageHolder() - Constructor for class com.arbortext.epic.prdata.MessageHolder
-
Initializes a new object.
- modCancel() - Method in class com.arbortext.epic.prdata.Database
-
Discard any changes to rules, rule sets, and rule files not already written to disk.
- modClearNewData() - Method in class com.arbortext.epic.prdata.Database
-
Discards any parameter or member information that was stored against the creation of a new rule or rule set.
- modClone(int) - Method in class com.arbortext.epic.prdata.Database
-
Replicates the parameters and members associated with an existing rule or rule set into the 'new parameter' and 'new members' lists.
- modCreateOperation(String, String, String, String, String) - Method in class com.arbortext.epic.prdata.Database
-
Creates a new rule or rule set.
- ModCreateRule - Class in com.arbortext.epic.prdata
-
Encapsulates an undoable 'create rule' operation.
- ModCreateRule(Rule, RuleFile, Database) - Constructor for class com.arbortext.epic.prdata.ModCreateRule
-
Initializes a new instance.
- ModCreateSet - Class in com.arbortext.epic.prdata
-
Encapsulates an undoable 'create rule set' operation.
- ModCreateSet(RuleSet, RuleFile, Database) - Constructor for class com.arbortext.epic.prdata.ModCreateSet
-
Initializes a new instance
- modDeleteRule(int) - Method in class com.arbortext.epic.prdata.Database
-
Deletes a rule from a rule file
- ModDeleteRule - Class in com.arbortext.epic.prdata
-
Describes an undoable 'delete rule' operation.
- ModDeleteRule(Rule, RuleFile, Database) - Constructor for class com.arbortext.epic.prdata.ModDeleteRule
-
Initializes a new instance
- modDeleteSet(int) - Method in class com.arbortext.epic.prdata.Database
-
Deletes a rule set from a rule file
- ModDeleteSet - Class in com.arbortext.epic.prdata
-
Encapsulates an undoable 'delete rule set' operation.
- ModDeleteSet(RuleSet, RuleFile, Database) - Constructor for class com.arbortext.epic.prdata.ModDeleteSet
-
Initializes a new instance
- modDescription(int, String) - Method in class com.arbortext.epic.prdata.Database
-
Modifies the description field of a rule or rule set.
- ModDescription - Class in com.arbortext.epic.prdata
-
Describes a undoable 'modify description' operation.
- ModDescription(Operation, String) - Constructor for class com.arbortext.epic.prdata.ModDescription
-
Initializes a new instance
- Modification - Interface in com.arbortext.epic.prdata
-
Interface representing a change to rules and rule sets.
- ModificationException - Exception Class in com.arbortext.epic.prdata
-
Encapsulates a failure to apply a modification.
- ModificationException() - Constructor for exception class com.arbortext.epic.prdata.ModificationException
-
Creates a new object with a null message.
- ModificationException(String) - Constructor for exception class com.arbortext.epic.prdata.ModificationException
-
Creates a new object.
- ModificationException(String, Throwable) - Constructor for exception class com.arbortext.epic.prdata.ModificationException
-
Creates a new object.
- ModificationException(Throwable) - Constructor for exception class com.arbortext.epic.prdata.ModificationException
-
Creates a new object with a null message and an underlying exception.
- modMemberAdd(int, int) - Method in class com.arbortext.epic.prdata.Database
-
Adds a member rule to a rule set.
- ModMemberAdd - Class in com.arbortext.epic.prdata
-
Encapsulates an undoable "add member" operation.
- ModMemberAdd(RuleSet, Rule) - Constructor for class com.arbortext.epic.prdata.ModMemberAdd
-
Initializes a new instance.
- modMemberDelete(int, int) - Method in class com.arbortext.epic.prdata.Database
-
Deletes a member rule from a rule set
- ModMemberDelete - Class in com.arbortext.epic.prdata
-
Encapsulates an undoable 'delete rule set member' operation.
- ModMemberDelete(RuleSet, int) - Constructor for class com.arbortext.epic.prdata.ModMemberDelete
-
Initializes a new instance.
- modMemberDeleteReference(int, int) - Method in class com.arbortext.epic.prdata.Database
-
Deletes a member rule from a rule set.
- modMemberMove(int, int, String) - Method in class com.arbortext.epic.prdata.Database
-
Moves a member rule up or down one position within a rule set.
- ModMemberMove - Class in com.arbortext.epic.prdata
-
Encapsulates an undoable "move member up/down" operation.
- ModMemberMove(RuleSet, Rule, boolean) - Constructor for class com.arbortext.epic.prdata.ModMemberMove
-
Initializes a new instance
- modParameterAdd(int, String, String) - Method in class com.arbortext.epic.prdata.Database
-
Adds a parameter to a rule or rule set
- ModParameterAdd - Class in com.arbortext.epic.prdata
-
Encapsulates an undoable "add parameter" operation.
- ModParameterAdd(Operation, String, String) - Constructor for class com.arbortext.epic.prdata.ModParameterAdd
-
Initializes a new instance.
- modParameterDelete(int, String) - Method in class com.arbortext.epic.prdata.Database
-
Removes a parameter from a rule or a rule set.
- ModParameterDelete - Class in com.arbortext.epic.prdata
-
Encapsulates an undoable 'delete parameter' operation.
- ModParameterDelete(Operation, Operation.ParameterWithIndex) - Constructor for class com.arbortext.epic.prdata.ModParameterDelete
-
Initializes a new operation.
- modParameterModify(int, String, String) - Method in class com.arbortext.epic.prdata.Database
-
Modifies the value of a rule or rule set parameter.
- ModParameterModify - Class in com.arbortext.epic.prdata
-
Encapsulates an undoable 'modify parameter' operation.
- ModParameterModify(Operation, Parameter, String) - Constructor for class com.arbortext.epic.prdata.ModParameterModify
-
Initializes a new instance.
- modSave() - Method in class com.arbortext.epic.prdata.Database
-
Saves any changes made by prior 'modxxx' calls by writing the rule files affected to disk.
- moveMember(Rule, boolean) - Method in class com.arbortext.epic.prdata.RuleSet
-
Moves a rule up or down one spot in the set.
O
- Operation - Class in com.arbortext.epic.prdata
-
Represents a publishing operation, something the user can start running.
- Operation() - Constructor for class com.arbortext.epic.prdata.Operation
-
Creates an in-memory "virtual" rule set container.
- Operation(RuleFile, String, String, String, int, Map<String, String>) - Constructor for class com.arbortext.epic.prdata.Operation
-
Initializes a new instance from a server-side PRCF descriptor.
- Operation(RuleFile, String, String, XmlObject, int, ParameterCollection, String) - Constructor for class com.arbortext.epic.prdata.Operation
-
Initializes a new instance.
- Operation(String, String, RuleFile, List<Parameter>) - Constructor for class com.arbortext.epic.prdata.Operation
-
Creates a new rule or rule set for the GUI.
- Operation.ParameterWithIndex - Class in com.arbortext.epic.prdata
- operationHasParameter(int, String) - Method in class com.arbortext.epic.prdata.Database
- operationIsSet(int) - Method in class com.arbortext.epic.prdata.Database
-
Indicates whether an operation is a rule set or a rule.
- OperationType - Class in com.arbortext.e3ci
-
Describes a composition operation defined in a rule file.
- OperationType - Class in com.arbortext.epic.prdata
-
Describes a type of Composition Operation.
- OperationType(RuleFile, CCOperationType, int) - Constructor for class com.arbortext.epic.prdata.OperationType
-
Creates a new object
- OperationType(RuleFile, TypeDefinition, int) - Constructor for class com.arbortext.epic.prdata.OperationType
-
Creates a new object
- OperationType(String, boolean, String, String, String, String, String, String, String, String) - Constructor for class com.arbortext.e3ci.OperationType
-
Creates a new object.
P
- PackagedApplication - Class in com.arbortext.e3ci
-
Describes a single packaged application installed in a PE subprocess.
- PackagedApplication(String, String, String, String, String, List) - Constructor for class com.arbortext.e3ci.PackagedApplication
-
Creates a new packaged application descriptor
- packageLogger - Static variable in class com.arbortext.e3ci.Application
-
Logger for tracing operation.
- Parameter - Class in com.arbortext.epic.prdata
-
Represents a composition parameter.
- Parameter(String, String) - Constructor for class com.arbortext.epic.prdata.Parameter
-
Creates a new parameter object
- ParameterWithIndex(Parameter, int) - Constructor for class com.arbortext.epic.prdata.Operation.ParameterWithIndex
- parseCompositionPathEntry(Element) - Method in class com.arbortext.e3ci.CompConfigRemote
-
parses a
element - ParsedPI - Class in com.arbortext.e3ci
-
Utility class for taking a processing instruction apart.
- ParsedPI(String) - Constructor for class com.arbortext.e3ci.ParsedPI
-
Initializes from the data part of a Processing Instruction object.
- parseFramesetPathEntry(Element) - Method in class com.arbortext.e3ci.CompConfigRemote
-
parses a
element - parseFramesetPathFiles(Element) - Method in class com.arbortext.e3ci.CompConfigRemote
- parseImportTemplate(Element) - Method in class com.arbortext.e3ci.CompConfigRemote
-
parses a
element - parsePathFile(Element, String, String) - Method in class com.arbortext.e3ci.CompConfigRemote
-
parses a
element - parsePdfConfigFile(Element) - Method in class com.arbortext.e3ci.CompConfigRemote
-
parses a
element - PATH - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- PathEntry - Class in com.arbortext.e3ci
-
Describes a single directory on a server path list.
- PathEntry(File) - Constructor for class com.arbortext.e3ci.PathEntry
-
Constructs a PathEntry containing every file in a directory.
- PathEntry(String) - Constructor for class com.arbortext.e3ci.PathEntry
-
Initializes a new PathEntry object
- pathsEqual(String, String) - Static method in class com.arbortext.e3ci.CompConfig
-
Compares to strings containing paths and indicates whether they're equal.
- popLogger() - Static method in class com.arbortext.epic.prdata.Database
-
Restores the logger to the value in use before pushLogger() was called.
- PRAuthor - Interface in com.arbortext.epic.prdata
-
Describes the author of a Publishing Rule Configuration File.
- PRAuthorInstalledApplication - Interface in com.arbortext.epic.prdata
-
Describes an Arborext packaged application that was installed and active when a rule file was created.
- PRDatabase - Interface in com.arbortext.epic.prdata
-
Interface describing the Pubishing Rule Database, which contains all known and usable publishing rules and rule sets.
- PRDoctype - Interface in com.arbortext.epic.prdata
-
Represents a document type that is associated with a publishing rule.
- PRLocation - Enum Class in com.arbortext.epic.prdata
-
Represents the possible locations for a rule file, rule, or rule set.
- PROperation - Interface in com.arbortext.epic.prdata
-
Represents a publishing operation, i.e., something that the user can start executing.
- PROperationType - Interface in com.arbortext.epic.prdata
-
Describes a publishing operation type.
- PROperationType.ResultType - Enum Class in com.arbortext.epic.prdata
- PRParameter - Interface in com.arbortext.epic.prdata
-
Describes a rule or rule set parameter.
- PRRule - Interface in com.arbortext.epic.prdata
-
Describes a Publishing Rule.
- PRRuleFile - Interface in com.arbortext.epic.prdata
-
Describes a rule file, which contains publishing rules, rule sets, and composition type definitions.
- PRRuleFileEntry - Interface in com.arbortext.epic.prdata
-
Describes an object that can be stored in a rule file.
- PRRuleSet - Interface in com.arbortext.epic.prdata
-
Describes a Publishing Rule Set.
- PRSetMember - Interface in com.arbortext.epic.prdata
-
Reference to a rule that is a member of a rule set.
- pushLogger(Logger) - Static method in class com.arbortext.epic.prdata.Database
-
Saves the current logger, then sets a new set.
R
- refresh() - Method in class com.arbortext.e3ci.Manager
-
Refetches our configuration object from the server
- report(ReportRuleDefinition) - Method in class com.arbortext.epic.prdata.Rule
-
Transcribes information about this rule into an XML report document.
- report(ReportRuleFile) - Method in class com.arbortext.epic.prdata.RuleFile
-
Transcribes information about this rule file into a subtree of an XML document.
- report(ReportRuleSetDefinition) - Method in class com.arbortext.epic.prdata.RuleSet
-
Transcribes information about this rule into an XML report document.
- report(ReportTypeDefinition) - Method in class com.arbortext.epic.prdata.OperationType
-
Transcribes information about this rule into a section of an XML document.
- rescan() - Method in class com.arbortext.epic.prdata.Database
-
Discards the current list of known publishing rules and builds a new list.
- restoreMember(SetMember, int) - Method in class com.arbortext.epic.prdata.RuleSet
-
Restores a member previously deleted from our rule list.
- restoreRule(Rule, RuleFile.DeletionLocation) - Method in class com.arbortext.epic.prdata.RuleFile
-
Restores a rule to the location from which it was previously deleted.
- restoreSet(RuleSet, RuleFile.DeletionLocation) - Method in class com.arbortext.epic.prdata.RuleFile
-
Restores a rule set to the location from which it was previously deleted.
- Rule - Class in com.arbortext.e3ci
- Rule - Class in com.arbortext.epic.prdata
-
Represents a Publishing Rule.
- Rule(RuleFile, CCRule, int) - Constructor for class com.arbortext.epic.prdata.Rule
-
Creates a new publishing rule.
- Rule(RuleFile, RuleDefinition, int) - Constructor for class com.arbortext.epic.prdata.Rule
-
Creates a new publishing rule.
- Rule(String, String, RuleFile, List<Parameter>, OperationType, String) - Constructor for class com.arbortext.epic.prdata.Rule
-
Creates a new rule for the GUI.
- Rule(String, String, String) - Constructor for class com.arbortext.e3ci.Rule
-
Creates a new instance.
- RuleFile - Class in com.arbortext.e3ci
-
Describes a Publishing Rule File on the PE Server.
- RuleFile - Class in com.arbortext.epic.prdata
-
Represents a single rule file.
- RuleFile() - Constructor for class com.arbortext.epic.prdata.RuleFile
-
Creates a "virtual" rule file that contains one rule set; both file and set are tempoary in-memory containers that exist to contain a single rule.
- RuleFile(CCRuleFile) - Constructor for class com.arbortext.epic.prdata.RuleFile
-
Creates a rule file descriptor from a Composition Configuration document entry describing a rule file on the PE server.
- RuleFile(File) - Constructor for class com.arbortext.epic.prdata.RuleFile
-
Creates a new instance from an on-disk PRCF file
- RuleFile(File, String) - Constructor for class com.arbortext.epic.prdata.RuleFile
-
Creates a new empty rule file.
- RuleFile(String, String) - Constructor for class com.arbortext.e3ci.RuleFile
-
Creates a new object.
- RuleFile.DeletionLocation - Class in com.arbortext.epic.prdata
- RuleFileEntry - Class in com.arbortext.epic.prdata
-
Base class for entries in a rule file.
- RuleFileEntry() - Constructor for class com.arbortext.epic.prdata.RuleFileEntry
-
Creates a new "virtual" element.
- RuleFileEntry(RuleFile, String, String, String, int) - Constructor for class com.arbortext.epic.prdata.RuleFileEntry
-
Creates a new object.
- RuleFileEntry(RuleFile, String, String, XmlObject, int) - Constructor for class com.arbortext.epic.prdata.RuleFileEntry
-
Creates a new object.
- RuleFileEntry(String, String, RuleFile) - Constructor for class com.arbortext.epic.prdata.RuleFileEntry
-
Creates a new element for the GUI.
- RuleFileException - Exception Class in com.arbortext.epic.prdata
-
Describes an error that occurs while reading data from a publishing rule file.
- RuleFileException() - Constructor for exception class com.arbortext.epic.prdata.RuleFileException
- RuleFileException(String) - Constructor for exception class com.arbortext.epic.prdata.RuleFileException
- RuleFileException(String, Throwable) - Constructor for exception class com.arbortext.epic.prdata.RuleFileException
- RuleFileException(Throwable) - Constructor for exception class com.arbortext.epic.prdata.RuleFileException
- RuleSet - Class in com.arbortext.e3ci
-
Describes a publishing rule set.
- RuleSet - Class in com.arbortext.epic.prdata
-
Represents a collection of rules that are executed in sequence.
- RuleSet() - Constructor for class com.arbortext.epic.prdata.RuleSet
-
Initializes a temporary in-memory rule container with no members.
- RuleSet(Rule) - Constructor for class com.arbortext.epic.prdata.RuleSet
-
Initializes a temporary in-memory rule container.
- RuleSet(RuleFile, CCRuleSet, int) - Constructor for class com.arbortext.epic.prdata.RuleSet
-
Initalizes a new rule set.
- RuleSet(RuleFile, RuleSetDefinition, int) - Constructor for class com.arbortext.epic.prdata.RuleSet
-
Initalizes a new rule set.
- RuleSet(String, String, String) - Constructor for class com.arbortext.e3ci.RuleSet
-
Initializes a new object.
- RuleSet(String, String, String, RuleFile, List<Parameter>, List<Rule>) - Constructor for class com.arbortext.epic.prdata.RuleSet
-
Creates a new rule set for the GUI.
- RuleSetManifest - Class in com.arbortext.epic.prdata
-
Creates a rule set manifest document using Java beans.
- RuleSetManifest(String, boolean, PRRuleSet, Map<String, String>) - Constructor for class com.arbortext.epic.prdata.RuleSetManifest
- RuleSetManifestException - Exception Class in com.arbortext.epic.prdata
-
Represents an error creating or using a rule set manifest.
- RuleSetManifestException() - Constructor for exception class com.arbortext.epic.prdata.RuleSetManifestException
- RuleSetManifestException(String) - Constructor for exception class com.arbortext.epic.prdata.RuleSetManifestException
- RuleSetManifestException(String, Throwable) - Constructor for exception class com.arbortext.epic.prdata.RuleSetManifestException
- RuleSetManifestException(Throwable) - Constructor for exception class com.arbortext.epic.prdata.RuleSetManifestException
S
- save() - Method in class com.arbortext.epic.prdata.RuleFile
-
Stores our content to disk
- save(AuthorDefinition) - Method in class com.arbortext.epic.prdata.Author
-
Stores the content of this object to an XML document
- save(RuleDefinition) - Method in class com.arbortext.epic.prdata.Rule
-
Saves this rule to a subtree of a rule file.
- save(RuleSetDefinition) - Method in class com.arbortext.epic.prdata.RuleSet
-
Saves this rule to a subtree of a rule file.
- save(TypeDefinition) - Method in class com.arbortext.epic.prdata.OperationType
-
Saves our content to a subtree of a rule file document.
- saveModifications() - Method in class com.arbortext.epic.prdata.RuleFile
-
Writes our content to disk and, if successful, discards any unsaved modifications.
- saveRuleLog(String, String, String) - Static method in class com.arbortext.epic.prdata.Database
-
Creates and writes to disk a composer log document containing just a specified portion of an existing composerlog document.
- serializeHtml(File, String, String, boolean, boolean) - Method in class com.arbortext.e3ci.CompConfigServer
-
Saves our content as an XML document
- serialVersionUID - Static variable in exception class com.arbortext.epic.prdata.ModificationException
- SERVER - Enum constant in enum class com.arbortext.epic.prdata.PRLocation
- setAlternateStylesheetDirectory(File) - Method in class com.arbortext.e3ci.DocConfigFile
-
Sets a new value for the the alternate stylesheet directory
- setConfigFiles(PathEntry) - Method in class com.arbortext.e3ci.Doctype
-
Stores a new configuration file value.
- setDescription(String) - Method in class com.arbortext.epic.prdata.RuleFileEntry
-
Modifies our 'description' field.
- setDtdPath(String) - Method in class com.arbortext.e3ci.Doctype
-
Store a new DTD path value
- setHTTPSPolicies(boolean, boolean) - Static method in class com.arbortext.e3ci.Manager
-
Sets HTTPS policy values
- setIgnored(boolean) - Method in class com.arbortext.epic.prdata.RuleFile
-
Sets our 'ignored' flag.
- setIgnored(boolean) - Method in class com.arbortext.epic.prdata.RuleFileEntry
-
Sets the 'ignored' flag so that this entry won't be used.
- SetMember - Class in com.arbortext.epic.prdata
-
Represents a reference to a rule from a rule set.
- SetMember(String, String) - Constructor for class com.arbortext.epic.prdata.SetMember
-
Creates new instance.
- setTestFile(String) - Static method in class com.arbortext.e3ci.Manager
-
Directs that we read configuration data from a specified test file instead of fetching it from E3.
- setTrace(int) - Static method in class com.arbortext.e3ci.Manager
-
Changes the value of the trace level
- setValue(String) - Method in class com.arbortext.epic.prdata.Parameter
-
Stores a new value.
- setXsdPath(String) - Method in class com.arbortext.e3ci.Doctype
-
Stores a new XSD path value
- startRule(PRRule, Map<String, String>, String) - Method in class com.arbortext.epic.prdata.RuleSetManifest
-
Starts a manifest file entry describing the execution of a rule.
- STYLER_VERSION - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- Stylesheet - Class in com.arbortext.e3ci
-
Class to describe a single stylesheet
- Stylesheet(String, String, String, String, boolean, String, boolean, Map<String, String>) - Constructor for class com.arbortext.e3ci.Stylesheet
-
Initializes a stylesheet descriptor
- Stylesheet(String, String, String, String, boolean, String, long, String, boolean, Map<String, String>) - Constructor for class com.arbortext.e3ci.Stylesheet
-
Constructor with file details.
- switchNewType(String) - Method in class com.arbortext.epic.prdata.Database
-
Switches to a new list of parameters for creating a new rule or rule set.
T
- tags - Search tag in com.arbortext.e3ci.CompConfig.toStringHtml(String, String, boolean, boolean)
- Section
- tags - Search tag in com.arbortext.e3ci.CompConfigServer.serializeHtml(File, String, String, boolean, boolean)
- Section
- tags - Search tag in com.arbortext.e3ci.CompositionConfiguration.toStringHtml(String, String, boolean, boolean)
- Section
- tags instead of and tags - Search tag in com.arbortext.e3ci.CompConfig.toStringHtml(String, String, boolean, boolean)
- Section
- testExecution(String, String) - Static method in class com.arbortext.epic.prdata.Database
-
Tests the capability for Java code to execute a Publishing Rule/Set.
- TITLE - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- toString() - Method in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- toString() - Method in class com.arbortext.e3ci.CompConfig
-
Translates our content into an XML document in a string
- toString() - Method in enum class com.arbortext.epic.prdata.PRLocation
- toString() - Method in enum class com.arbortext.epic.prdata.PROperationType.ResultType
- toStringHtml(String, String, boolean, boolean) - Method in class com.arbortext.e3ci.CompConfig
-
Translates an HTML version of our content into a string
- toStringHtml(String, String, boolean, boolean) - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Translates an HTML version of our content into a string
U
- undo() - Method in class com.arbortext.epic.prdata.ModCreateRule
-
Undoes the addition of our rule to its rule file and to the global database.
- undo() - Method in class com.arbortext.epic.prdata.ModCreateSet
-
Undoes the previous 'add rule set' operation.
- undo() - Method in class com.arbortext.epic.prdata.ModDeleteRule
-
Restores our rule to its rule file and to the global database
- undo() - Method in class com.arbortext.epic.prdata.ModDeleteSet
-
Restores our rule set to its rule file and to the global database
- undo() - Method in class com.arbortext.epic.prdata.ModDescription
-
Undoes the modification of the operation description.
- undo() - Method in interface com.arbortext.epic.prdata.Modification
-
Undoes the change that this object encapsulates and restores the world to its prevous state.
- undo() - Method in class com.arbortext.epic.prdata.ModMemberAdd
-
Undoes the prior addition of a member to a rule set.
- undo() - Method in class com.arbortext.epic.prdata.ModMemberDelete
-
Undoes a prior member rule deletion.
- undo() - Method in class com.arbortext.epic.prdata.ModMemberMove
- undo() - Method in class com.arbortext.epic.prdata.ModParameterAdd
-
Undoes the prior 'insert' operation.
- undo() - Method in class com.arbortext.epic.prdata.ModParameterDelete
-
Undoes the parameter modification we made earlier.
- undo() - Method in class com.arbortext.epic.prdata.ModParameterModify
-
Undoes the parameter modification we made earlier.
- UNKNOWN - Enum constant in enum class com.arbortext.epic.prdata.PRLocation
- updateTime() - Method in class com.arbortext.epic.prdata.Author
-
Update our modification timestamp to the current date/time.
- updateTime() - Method in interface com.arbortext.epic.prdata.PRAuthor
-
Updates our time stamp to the current time.
- useDistiller() - Method in class com.arbortext.e3ci.CompConfig
-
Indicates whether the E3 server will use Distiller or pubpdf to generate PDF
- useDistiller() - Method in interface com.arbortext.e3ci.CompositionConfiguration
-
Indicates whether server will use distiller of pubpdf when generating PDF.
- useDistiller() - Method in class com.arbortext.e3ci.Manager
-
Indicates whether the E3 server will use Distiller of pubpdf to generate PDF output
- USES - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
V
- validateUrl(String) - Method in class com.arbortext.e3ci.Manager
-
Called by Epic when user tries to change the value of the "e3serverurl" option.
- validForUse(String) - Method in class com.arbortext.e3ci.AppConfigFile
-
Indicates whether this APP Config File supports a particular publishing operation.
- validForUse(String) - Method in interface com.arbortext.e3ci.CCAppConfigFile
-
Indicates whether this APP config file supports a particular publishing operation.
- validForUse(String) - Method in interface com.arbortext.e3ci.CCStylesheet
-
Indicates whether the given composition type is in this stylesheet's list of supported composition types
- validForUse(String) - Method in class com.arbortext.e3ci.Stylesheet
-
Indicates whether the given composition type is in this stylesheet's list of supported composition types
- valueOf(String) - Static method in enum class com.arbortext.e3ci.CCStylesheetInfoKey
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.arbortext.epic.prdata.PRLocation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.arbortext.epic.prdata.PROperationType.ResultType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.arbortext.e3ci.CCStylesheetInfoKey
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.arbortext.epic.prdata.PRLocation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.arbortext.epic.prdata.PROperationType.ResultType
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- writeCompConfigComparison(String) - Static method in class com.arbortext.e3ci.Manager
-
Writes an XHTML file of a comparison between the client and server versions of the Composition Configuration.
- writeReport(String) - Method in class com.arbortext.epic.prdata.Database
-
Writes a report on our content.
X
- XHTML5_DMP - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- XHTML5_EPUB - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- XHTML5_HTML - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- XHTML5_HTMLHELP - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
- XHTML5_WEB - Enum constant in enum class com.arbortext.e3ci.CCStylesheetInfoKey
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form