DITA 맵에서 작동하는 Java 기반 API id175UB30E05Z

Last update: Fri Jan 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:
Java-Based API Dita Map

작성 대상:

Experienced
Developer

다음 Java 기반 API를 사용하면 AEM Guides에서 DITA 맵으로 작업할 수 있습니다. 이러한 API는 번들 형태로 사용할 수 있습니다. 이러한 API를 사용하려면 코드에 이 번들을 포함해야 합니다.

번들 세부 정보:

그룹 ID: com.adobe.fmdita
아티팩트 ID: api
버전: 3.2
패키지: com.adobe.fmdita.api.maps

클래스 세부 사항:

code language-java
`public class MapUtilities extends Object`

MapUtilities 클래스에는 DITA 맵 파일에서 메타데이터 정보를 검색하는 메서드가 포함되어 있습니다.

종속 항목이 있는 DITA 맵 다운로드

다음 zipMapWithDependents 메서드는 참조된 주제, 하위 맵, 이미지 및 DTD와 같은 모든 종속 항목과 함께 DITA 맵이 포함된 .zip 파일을 만듭니다. DITA 맵에 대한 .zip 파일은 지정된 기준선을 기반으로 생성됩니다.

또한 동일한 구조 (상위 및 하위 폴더)를 유지하거나 모든 종속 파일에 대해 단일 폴더 내에 플랫 파일 구조를 만들 수 있습니다.

IMPORTANT

종속 파일이 누락된 경우 API에서 예외가 발생하고 .zip 파일을 만들지 못합니다.

구문:

public static void zipMapWithDependents(Session session,
                     String sourcePath,
                     String baseline,
                     OutputStream outputStream,
                     boolean flatFS)
                     throws RepositoryException, IOException

매개 변수: 이름|유형|설명| ---- --------------- |session|javax.jcr.Session|유효한 JCR 세션입니다.| |sourcePath다운로드해야 하는 DITA 맵 파일의 |String|Path(AEM 저장소 내).| |outputStream|java.io.OutputStream|ZIP을 쓸 스트림입니다.| |baseline|문자열|버전이 지정된 콘텐츠를 검색하는 데 사용되는 기준선의 제목입니다.
참고: 값은 대/소문자를 구분합니다.| |flatFS|Boolean|(선택 사항) true로 설정하면 파일의 플랫 구조가 ZIP 파일에 반환됩니다. 예를 들어 DITA 맵이 여러 폴더의 콘텐츠를 참조하는 경우 참조된 모든 파일을 단일 폴더로 가져옵니다. 이름이 같은 파일이 있는 경우 숫자 접미사를 추가하여 해당 파일의 이름을 바꿉니다. 플랫 폴더 구조에서 파일의 새 위치를 기반으로 업데이트되므로 모든 참조 (DITA 맵 및 주제)가 자동으로 처리됩니다. false로 설정하면 폴더 구조가 ZIP 파일에서 그대로 유지됩니다. DITA 맵이 여러 위치의 파일을 참조하는 경우 이러한 모든 위치도 ZIP 파일에 생성됩니다. ZIP 파일을 복원하면 대상 위치에 정확한 폴더 구조가 생성됩니다.
이 매개 변수의 기본값은 false입니다.|

반환: ZIP의 콘텐츠는 outputStream.

예외: throw javax.jcr.RepositoryException, java.io.IOException.

종속 항목이 있는 DITA 맵 다운로드 (비동기적으로)

또는 비동기 모드에서 종속 항목이 있는 DITA 맵을 다운로드할 수 있습니다. 이 방법은 더 큰 DITA 맵에 더 유용합니다.

또한 동일한 구조 (상위 및 하위 폴더)를 유지하거나 모든 종속 파일에 대해 단일 폴더 내에 플랫 파일 구조를 만들 수 있습니다.

NOTE

이 노드는 정의된 경우 output.history.purgetime 구성을 기반으로 잠시 후 자동으로 삭제되거나 기본값으로 5일 삭제됩니다.

구문:

public static CompletableFuture<Node> zipMapWithDependencies(Session session,
                     String sourcePath,
                     String baseline,
                     boolean flatFS)

매개 변수: 이름|유형|설명| ---- --------------- |session|javax.jcr.Session|유효한 JCR 세션입니다.| |sourcePath다운로드해야 하는 DITA 맵 파일의 |String|Path(AEM 저장소 내).| |baseline|문자열|버전이 지정된 콘텐츠를 검색하는 데 사용되는 기준선의 제목입니다.
참고: 값은 대/소문자를 구분합니다.| |flatFS|Boolean|(선택 사항) true로 설정하면 파일의 플랫 구조가 ZIP 파일에 반환됩니다. 예를 들어 DITA 맵이 여러 폴더의 콘텐츠를 참조하는 경우 참조된 모든 파일을 단일 폴더로 가져옵니다. 이름이 같은 파일이 있는 경우 숫자 접미사를 추가하여 해당 파일의 이름을 바꿉니다. 플랫 폴더 구조에서 파일의 새 위치를 기반으로 업데이트되므로 모든 참조 (DITA 맵 및 주제)가 자동으로 처리됩니다. false로 설정하면 폴더 구조가 ZIP 파일에서 그대로 유지됩니다. DITA 맵이 여러 위치의 파일을 참조하는 경우 이러한 모든 위치도 ZIP 파일에 생성됩니다. ZIP 파일을 복원하면 대상 위치에 정확한 폴더 구조가 생성됩니다.
이 매개 변수의 기본값은 false입니다.|

반환: zip 파일의 노드가 CompletableFuture클래스. 사용자는 비동기적으로 계속 처리할 수 있으며 .get()노드가 필요할 때 스레드를 차단하는 향후 메서드입니다. 반환된 값은 오류로 끝날 수도 있으며, 다음을 사용하여 처리할 수 있습니다. .exceptionally() 메서드를 사용합니다.

기준선 목록 가져오기

다음 getBaselineList 메서드는 지정된 DITA 맵에 대해 존재하는 모든 기준선 목록을 검색합니다.

구문:

public static List<HashMap<String,String>> getBaselineList(
                  javax.jcr.Session session,
                  String sourcePath)
                  throws javax.jcr.RepositoryException

매개 변수: 이름|유형|설명| ---- --------------- |session|javax.jcr.Session|유효한 JCR 세션입니다.| |sourcePath|String|기준 요소 정보를 검색할 DITA 맵 파일의 경로 (AEM 저장소 내)|

반환: 의 목록 HashMap 개체. 각 HashMap 객체는 베이스라인을 나타내며 베이스라인의 이름과 제목을 포함합니다.

예외: throw javax.jcr.RepositoryException.

조건부 사전 설정 목록 가져오기

다음 getConditionalPresetList 메서드는 지정된 DITA 맵에 대해 존재하는 모든 조건부 사전 설정 목록을 검색합니다.

구문:

public static List<HashMap<String,String>> getConditionalPresetList (
                  javax.jcr.Session session,
                  String sourcePath)
                  throws javax.jcr.RepositoryException

매개 변수: 이름|유형|설명| ---- --------------- |session|javax.jcr.Session|유효한 JCR 세션입니다.| |sourcePath|String|조건부 사전 설정 정보를 검색할 DITA 맵 파일의 경로 (AEM 저장소).|

반환: 의 목록 HashMap 개체. 각 HashMap object 는 조건부 사전 설정을 나타내며 조건부 사전 설정의 이름과 제목을 포함합니다.

예외: throw javax.jcr.RepositoryException.

조건부 사전 설정에 대한 DITAVAL 파일 정보 가져오기

다음 getDitavalFromConditionalPreset 메서드는 지정된 DITA 맵에 대한 조건부 사전 설정에 해당하는 DITAVAL 파일의 경로를 검색합니다.

구문:

public static String getDitavalFromConditionalPreset
    (Session session,
    String sourcePath,
    String cpName) throws RepositoryException

매개 변수: 이름|유형|설명| ---- --------------- |session|javax.jcr.Session|유효한 JCR 세션입니다.| |sourcePath|String|DITAVAL 파일을 검색할 DITA 맵 파일의 경로 (AEM 저장소).| |cpName|문자열|DITAVAL 파일을 검색할 DITA 맵의 조건부 사전 설정 이름.|

반환: DITA 맵 파일에 정의된 조건부 사전 설정에 해당하는 DITAVAL 파일의 경로입니다.

노드에 대한 모든 종속성 가져오기

다음 getAllDependencies 메서드는 주어진 노드의 모든 종속성을 반환합니다.

구문:

public static List
<Node> getAllDependencies
(Node rootNode) throws GuidesApiException

매개 변수: 이름|유형|설명| ---- --------------- |rootNode|javax.jcr.Node|모든 종속성을 검색할 루트 노드입니다.|

반환: 루트 노드의 모든 종속성이 포함된 노드 목록입니다.

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178